summaryrefslogtreecommitdiff
path: root/vcl/unx/inc/xsalprn.h
blob: f0d0d2951bd865b248e1067b06ffa49b2e7353ce (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/*************************************************************************
 *
 *  $RCSfile: xsalprn.h,v $
 *
 *  $Revision: 1.1.1.1 $
 *
 *  last change: $Author: hr $ $Date: 2000-09-18 17:05:42 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __salprint_h
#define __salprint_h


class String;

#ifdef __cplusplus
extern "C" {
#endif

/* printer interface */
extern int XSalIsDisplay( const Display * );
extern int XSalIsPrinter( const Display * );

/* error handling */
typedef int (*XSalPrinterErrorHandler)( XErrorEvent * );

extern XSalPrinterErrorHandler XSalSetPrinterErrorHandler( XSalPrinterErrorHandler );

/* common callbacks */
typedef void* XSalPointer;
typedef int (*XSalPrinterCallback)( XSalPointer cb_data, XSalPointer client_data );

#ifndef _SV_SV_H
#define _SV_SV_H
#define USHORT unsigned short
#include <prntypes.hxx>
#undef USHORT
#undef _SV_SV_H
#else
#include <prntypes.hxx>
#endif

typedef enum Orientation Orientation;

/* initialize before first use */
extern void XSalPrinterInit( const String& installPath );

typedef unsigned short XSalEnum;
typedef unsigned char  XSalBool;

#define COLOR_SPACE_COLOR   1
#define COLOR_SPACE_GRAY    0

typedef struct
{
    unsigned int    nMagic;             /* internal data                */
    unsigned short  nVersion;           /* internal data                */
    unsigned short  nFlags;             /* internal data                */
    XSalEnum        eDriver;            /* PostScript, PCL, ...         */
    unsigned short  nCopies;            /* number of copies             */
    unsigned short  nPaperBin;          /* paper bin to use             */
    XSalEnum        ePaper;             /* A4, A5, ...                  */
    unsigned int    nPaperWidth;        /* paper width if PAPER_USER    */
    unsigned int    nPaperHeight;       /* paper height if PAPER_USER   */
    XSalEnum        eOrientation;       /* portrait / landscape         */
    unsigned int    nScale;             /* [%] ( 100 => 1:1 )           */
    unsigned short  nResolutionX;       /* [dots per inch]              */
    unsigned short  nResolutionY;       /* [dots per inch]              */
    char            sCompatCommand[256];/* current shell command        */
    char            sPort[256];         /* default shell command        */
    char            cDriverName[32];    /* Druckertreibername           */
    unsigned int    nTrailingBytes;     /* trailing bytes appended to this structure */
} XSalPrinterSetup;

#define XSAL_PRINTER_SETUP_MAGIC    0x0000ede1
#define WRONG_ENDIANESS_MAGIC       0xe1ed0000

/* definition for XSalPrinterSetup.nFlags */
#define XSALPRINTERSETUP_FLAG_LEVEL_DEFAULT     0x0000
#define XSALPRINTERSETUP_FLAG_LEVEL             0x000f
#define XSALPRINTERSETUP_FLAG_LEVEL_SHIFT       0
#define XSALPRINTERSETUP_FLAG_COLOR             0x0010  /* colored bitmaps  */
#define XSALPRINTERSETUP_FLAG_COLOR_DEFAULT     0x0020
#define XSALPRINTERSETUP_FLAG_COMPRESS          0x0040  /* compress bitmaps */
#define XSALPRINTERSETUP_FLAG_COMPRESS_DEFAULT  0x0080  /* compress bitmaps */
#define XSALPRINTERSETUP_FLAG_DEPTH_DEFAULT     0x0700
#define XSALPRINTERSETUP_FLAG_DEPTH             0x0700  /* depth n = depth 2^n, 6 = 24Bit, 7 = default */
#define XSALPRINTERSETUP_FLAG_DEPTH_SHIFT       8

#define XSALPRINTERSETUP_FLAG_DEFAULT\
                                (XSALPRINTERSETUP_FLAG_LEVEL_DEFAULT | \
                                 XSALPRINTERSETUP_FLAG_COMPRESS_DEFAULT | \
                                 XSALPRINTERSETUP_FLAG_COLOR_DEFAULT | \
                                 XSALPRINTERSETUP_FLAG_DEPTH_DEFAULT )


/* XSalPrinterSetup access */
extern unsigned short XSalGetPrinterDriverId( const char* driverName );
extern const char* XSalGetPrinterDriverName( unsigned short driverId );

extern unsigned short XSalGetLanguageLevel( const XSalPrinterSetup* pSetup );
extern void XSalGetLanguageLevels(
    const XSalPrinterSetup* pSetup,
    unsigned short* minLevel,
    unsigned short* maxLevel );
extern void XSalSetLanguageLevel( XSalPrinterSetup* pSetup, unsigned short);

extern unsigned short XSalGetDepth(  const XSalPrinterSetup* pSetup );
extern void XSalSetDepth( XSalPrinterSetup* pSetup, unsigned short depth );

extern XSalEnum XSalGetColorSpace( const XSalPrinterSetup* pSetup );
extern void XSalSetColorSpace( XSalPrinterSetup* pSetup, XSalEnum space );

extern XSalBool XSalGetBmpCompression( const XSalPrinterSetup* pSetup );
extern void XSalSetBmpCompression( XSalPrinterSetup* pSetup, XSalBool compress );

extern XSalEnum XSalGetOrientation( const char* string );
extern const char* XSalGetOrientationName( XSalEnum eOrientation );

extern XSalEnum XSalGetPaper( const char* sPaperName );
extern const char* XSalGetPaperName( XSalEnum ePaper );

/* use XSalInitPrinterSetup to initialize internal data */
extern void XSalInitPrinterSetup( XSalPrinterSetup* );
extern void XSalCorrectEndianess( XSalPrinterSetup* );
extern void XSalSetupPrinterSetup( XSalPrinterSetup*, Display* display, XLIB_Window parent);


/* the following two functions set defaults of the profile */
extern void XSalReadPrinterSetup( XSalPrinterSetup*, const String& rPrinter );
extern void XSalReadPrinterSetupDefaults( XSalPrinterSetup* );


typedef Display XSalPrinter;    /* an XSalPrinter is a Display. Draw into RootWindow */


/* open, change setup and close printer */
extern XSalPrinter* XSalOpenPrinter( const XSalPrinterSetup * pSetup, const String& rPrinterName, const String& rPrintFile );
/* XSalSetupPrinter() can setup: Orientation, Copies, Page, PaperBin */
extern void XSalSetupPrinter( XSalPrinter *, const XSalPrinterSetup * pSetup );
extern void XSalClosePrinter( XSalPrinter * );

typedef struct
{
  int nWidth;           /* [dots] drawable area */
  int nHeight;          /* [dots] drawable area */
  int nMarginLeft;      /* [dots] left margin   */
  int nMarginTop;       /* [dots] top margin    */
  int nMarginRight;     /* [dots] right margin  */
  int nMarginBottom;    /* [dots] bottom margin */
  int nResolutionX;     /* [dpi] resolution x   */
  int nResolutionY;     /* [dpi] resolution y   */
} XSalPageInfo;

extern void XSalGetPageInfo(
    const XSalPrinter* printer,
    const XSalPrinterSetup* pSetup,
    XSalPageInfo* pPageInfo );


/* printer job control */
extern int XSalStartDoc( XSalPrinter * printer, const String& jobName );
extern int XSalStartPage( XSalPrinter * printer );
extern int XSalEndPage( XSalPrinter * printer );
extern int XSalEndDoc( XSalPrinter * printer );
extern int XSalAbortDoc( XSalPrinter * printer );

#ifdef __cplusplus
} // extern "C"
#endif

#endif