]> git.saurik.com Git - wxWidgets.git/blame - include/wx/gtk/print.h
Fix wrong format specifiers in the samples.
[wxWidgets.git] / include / wx / gtk / print.h
CommitLineData
fa034c45
RR
1/////////////////////////////////////////////////////////////////////////////
2// Name: wx/gtk/print.h
3// Author: Anthony Bretaudeau
4// Purpose: GTK printing support
5// Created: 2007-08-25
a9a4f229 6// RCS-ID: $Id$
d494613a 7// Copyright: (c) Anthony Bretaudeau
fa034c45
RR
8// Licence: wxWindows Licence
9/////////////////////////////////////////////////////////////////////////////
10
11#ifndef _WX_GTK_PRINT_H_
12#define _WX_GTK_PRINT_H_
13
14#include "wx/defs.h"
15
16#if wxUSE_GTKPRINT
17
18#include "wx/print.h"
19#include "wx/printdlg.h"
20#include "wx/prntbase.h"
21#include "wx/dc.h"
d494613a
RR
22#include "wx/cairo.h"
23
fa034c45
RR
24
25typedef struct _GtkPrintOperation GtkPrintOperation;
26typedef struct _GtkPrintContext GtkPrintContext;
27typedef struct _GtkPrintSettings GtkPrintSettings;
28typedef struct _GtkPageSetup GtkPageSetup;
29
30typedef struct _cairo cairo_t;
31
32//----------------------------------------------------------------------------
33// wxGtkPrintFactory
34//----------------------------------------------------------------------------
35
36class wxGtkPrintFactory: public wxPrintFactory
37{
38public:
39 virtual wxPrinterBase *CreatePrinter( wxPrintDialogData *data );
40
41 virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
42 wxPrintout *printout = NULL,
43 wxPrintDialogData *data = NULL );
44 virtual wxPrintPreviewBase *CreatePrintPreview( wxPrintout *preview,
45 wxPrintout *printout,
46 wxPrintData *data );
47
48 virtual wxPrintDialogBase *CreatePrintDialog( wxWindow *parent,
49 wxPrintDialogData *data = NULL );
50 virtual wxPrintDialogBase *CreatePrintDialog( wxWindow *parent,
51 wxPrintData *data );
52
53 virtual wxPageSetupDialogBase *CreatePageSetupDialog( wxWindow *parent,
54 wxPageSetupDialogData * data = NULL );
55
888dde65 56 virtual wxDCImpl* CreatePrinterDCImpl( wxPrinterDC *owner, const wxPrintData& data );
fa034c45
RR
57
58 virtual bool HasPrintSetupDialog();
59 virtual wxDialog *CreatePrintSetupDialog( wxWindow *parent, wxPrintData *data );
60 virtual bool HasOwnPrintToFile();
61 virtual bool HasPrinterLine();
62 virtual wxString CreatePrinterLine();
63 virtual bool HasStatusLine();
64 virtual wxString CreateStatusLine();
65
66 virtual wxPrintNativeDataBase *CreatePrintNativeData();
67};
68
69//----------------------------------------------------------------------------
70// wxGtkPrintDialog
71//----------------------------------------------------------------------------
72
73class WXDLLIMPEXP_CORE wxGtkPrintDialog: public wxPrintDialogBase
74{
75public:
76 wxGtkPrintDialog( wxWindow *parent,
77 wxPrintDialogData* data = NULL );
78 wxGtkPrintDialog( wxWindow *parent, wxPrintData* data);
79 virtual ~wxGtkPrintDialog();
80
81 wxPrintData& GetPrintData()
82 { return m_printDialogData.GetPrintData(); }
83 wxPrintDialogData& GetPrintDialogData()
84 { return m_printDialogData; }
85
86 wxDC *GetPrintDC() { return m_dc; }
87 void SetPrintDC(wxDC * printDC) { m_dc = printDC; }
88
89 virtual int ShowModal();
90
91 virtual bool Validate() { return true; }
92 virtual bool TransferDataToWindow() { return true; }
93 virtual bool TransferDataFromWindow() { return true; }
94
95 void SetShowDialog(bool show) { m_showDialog = show; }
96 bool GetShowDialog() { return m_showDialog; }
97
98protected:
99 // Implement some base class methods to do nothing to avoid asserts and
100 // GTK warnings, since this is not a real wxDialog.
101 virtual void DoSetSize(int WXUNUSED(x), int WXUNUSED(y),
102 int WXUNUSED(width), int WXUNUSED(height),
103 int WXUNUSED(sizeFlags) = wxSIZE_AUTO) {}
104 virtual void DoMoveWindow(int WXUNUSED(x), int WXUNUSED(y),
105 int WXUNUSED(width), int WXUNUSED(height)) {}
106
107private:
108 wxPrintDialogData m_printDialogData;
109 wxWindow *m_parent;
110 bool m_showDialog;
111 wxDC *m_dc;
112
113 DECLARE_DYNAMIC_CLASS(wxGtkPrintDialog)
114};
115
116//----------------------------------------------------------------------------
117// wxGtkPageSetupDialog
118//----------------------------------------------------------------------------
119
120class WXDLLIMPEXP_CORE wxGtkPageSetupDialog: public wxPageSetupDialogBase
121{
122public:
123 wxGtkPageSetupDialog( wxWindow *parent,
124 wxPageSetupDialogData* data = NULL );
125 virtual ~wxGtkPageSetupDialog();
126
127 virtual wxPageSetupDialogData& GetPageSetupDialogData() { return m_pageDialogData; }
128
129 virtual int ShowModal();
130
131 virtual bool Validate() { return true; }
132 virtual bool TransferDataToWindow() { return true; }
133 virtual bool TransferDataFromWindow() { return true; }
134
135protected:
136 // Implement some base class methods to do nothing to avoid asserts and
137 // GTK warnings, since this is not a real wxDialog.
138 virtual void DoSetSize(int WXUNUSED(x), int WXUNUSED(y),
139 int WXUNUSED(width), int WXUNUSED(height),
140 int WXUNUSED(sizeFlags) = wxSIZE_AUTO) {}
141 virtual void DoMoveWindow(int WXUNUSED(x), int WXUNUSED(y),
142 int WXUNUSED(width), int WXUNUSED(height)) {}
143
144private:
145 wxPageSetupDialogData m_pageDialogData;
146 wxWindow *m_parent;
147
148 DECLARE_DYNAMIC_CLASS(wxGtkPageSetupDialog)
149};
150
151//----------------------------------------------------------------------------
152// wxGtkPrinter
153//----------------------------------------------------------------------------
154
155class WXDLLIMPEXP_CORE wxGtkPrinter : public wxPrinterBase
156{
157public:
158 wxGtkPrinter(wxPrintDialogData *data = NULL);
159 virtual ~wxGtkPrinter();
160
161 virtual bool Print(wxWindow *parent,
162 wxPrintout *printout,
163 bool prompt = true);
164 virtual wxDC* PrintDialog(wxWindow *parent);
165 virtual bool Setup(wxWindow *parent);
166
167 GtkPrintContext *GetPrintContext() { return m_gpc; }
168 void SetPrintContext(GtkPrintContext *context) {m_gpc = context;}
169 void BeginPrint(wxPrintout *printout, GtkPrintOperation *operation, GtkPrintContext *context);
170 void DrawPage(wxPrintout *printout, GtkPrintOperation *operation, GtkPrintContext *context, int page_nr);
171
172private:
173 GtkPrintContext *m_gpc;
fa034c45
RR
174 wxDC *m_dc;
175
176 DECLARE_DYNAMIC_CLASS(wxGtkPrinter)
c0c133e1 177 wxDECLARE_NO_COPY_CLASS(wxGtkPrinter);
fa034c45
RR
178};
179
180//----------------------------------------------------------------------------
181// wxGtkPrintNativeData
182//----------------------------------------------------------------------------
183
184class WXDLLIMPEXP_CORE wxGtkPrintNativeData : public wxPrintNativeDataBase
185{
186public:
187 wxGtkPrintNativeData();
188 virtual ~wxGtkPrintNativeData();
189
190 virtual bool TransferTo( wxPrintData &data );
191 virtual bool TransferFrom( const wxPrintData &data );
192
193 virtual bool Ok() const { return IsOk(); }
194 virtual bool IsOk() const { return true; }
195
196 GtkPrintSettings* GetPrintConfig() { return m_config; }
197 void SetPrintConfig( GtkPrintSettings * config );
198
fa034c45
RR
199 GtkPrintOperation* GetPrintJob() { return m_job; }
200
201 GtkPrintContext *GetPrintContext() { return m_context; }
202 void SetPrintContext(GtkPrintContext *context) {m_context = context; }
203
204
205 GtkPageSetup* GetPageSetupFromSettings(GtkPrintSettings* settings);
206 void SetPageSetupToSettings(GtkPrintSettings* settings, GtkPageSetup* page_setup);
207
208private:
209 GtkPrintSettings *m_config;
210 GtkPrintOperation *m_job;
211 GtkPrintContext *m_context;
212
213 DECLARE_DYNAMIC_CLASS(wxGtkPrintNativeData)
214};
215
216//-----------------------------------------------------------------------------
c8ddadff 217// wxGtkPrinterDC
fa034c45
RR
218//-----------------------------------------------------------------------------
219
888dde65 220class WXDLLIMPEXP_CORE wxGtkPrinterDCImpl : public wxDCImpl
fa034c45
RR
221{
222public:
888dde65 223 wxGtkPrinterDCImpl( wxPrinterDC *owner, const wxPrintData& data );
888dde65 224 virtual ~wxGtkPrinterDCImpl();
fa034c45
RR
225
226 bool Ok() const { return IsOk(); }
227 bool IsOk() const;
228
0b822969 229 virtual void* GetCairoContext() const;
2b44ffc0 230
fa034c45
RR
231 bool CanDrawBitmap() const { return true; }
232 void Clear();
233 void SetFont( const wxFont& font );
234 void SetPen( const wxPen& pen );
235 void SetBrush( const wxBrush& brush );
89efaf2b 236 void SetLogicalFunction( wxRasterOperationMode function );
fa034c45
RR
237 void SetBackground( const wxBrush& brush );
238 void DestroyClippingRegion();
239 bool StartDoc(const wxString& message);
240 void EndDoc();
241 void StartPage();
242 void EndPage();
243 wxCoord GetCharHeight() const;
244 wxCoord GetCharWidth() const;
245 bool CanGetTextExtent() const { return true; }
246 wxSize GetPPI() const;
fa034c45 247 virtual int GetDepth() const { return 24; }
a9312950 248 void SetBackgroundMode(int mode);
fa034c45 249 void SetPalette(const wxPalette& WXUNUSED(palette)) { }
a9312950 250 void SetResolution(int ppi);
6d52ca53 251
4c51a665 252 // overridden for wxPrinterDC Impl
6d52ca53
FM
253 virtual int GetResolution() const;
254 virtual wxRect GetPaperRect() const;
fa034c45
RR
255
256protected:
03647350 257 bool DoFloodFill(wxCoord x1, wxCoord y1, const wxColour &col,
89efaf2b 258 wxFloodFillStyle style=wxFLOOD_SURFACE );
fa034c45
RR
259 void DoGradientFillConcentric(const wxRect& rect, const wxColour& initialColour, const wxColour& destColour, const wxPoint& circleCenter);
260 void DoGradientFillLinear(const wxRect& rect, const wxColour& initialColour, const wxColour& destColour, wxDirection nDirection = wxEAST);
261 bool DoGetPixel(wxCoord x1, wxCoord y1, wxColour *col) const;
262 void DoDrawLine(wxCoord x1, wxCoord y1, wxCoord x2, wxCoord y2);
263 void DoCrossHair(wxCoord x, wxCoord y);
264 void DoDrawArc(wxCoord x1,wxCoord y1,wxCoord x2,wxCoord y2,wxCoord xc,wxCoord yc);
265 void DoDrawEllipticArc(wxCoord x,wxCoord y,wxCoord w,wxCoord h,double sa,double ea);
266 void DoDrawPoint(wxCoord x, wxCoord y);
267 void DoDrawLines(int n, wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0);
89efaf2b
FM
268 void DoDrawPolygon(int n, wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0, wxPolygonFillMode fillStyle=wxODDEVEN_RULE);
269 void DoDrawPolyPolygon(int n, int count[], wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0, wxPolygonFillMode fillStyle=wxODDEVEN_RULE);
fa034c45
RR
270 void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
271 void DoDrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height, double radius = 20.0);
272 void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
273#if wxUSE_SPLINES
b0d7707b 274 void DoDrawSpline(const wxPointList *points);
c8ddadff 275#endif
fa034c45 276 bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
03647350 277 wxDC *source, wxCoord xsrc, wxCoord ysrc,
89efaf2b 278 wxRasterOperationMode rop = wxCOPY, bool useMask = false,
fa034c45
RR
279 wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
280 void DoDrawIcon( const wxIcon& icon, wxCoord x, wxCoord y );
281 void DoDrawBitmap( const wxBitmap& bitmap, wxCoord x, wxCoord y, bool useMask = false );
fa034c45
RR
282 void DoDrawText(const wxString& text, wxCoord x, wxCoord y );
283 void DoDrawRotatedText(const wxString& text, wxCoord x, wxCoord y, double angle);
284 void DoSetClippingRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
fdaad94e
VZ
285 void DoSetDeviceClippingRegion( const wxRegion &WXUNUSED(clip) )
286 {
287 wxFAIL_MSG( "not implemented" );
288 }
fa034c45 289 void DoGetTextExtent(const wxString& string, wxCoord *x, wxCoord *y,
d3b9f782
VZ
290 wxCoord *descent = NULL,
291 wxCoord *externalLeading = NULL,
292 const wxFont *theFont = NULL ) const;
fa034c45
RR
293 void DoGetSize(int* width, int* height) const;
294 void DoGetSizeMM(int *width, int *height) const;
295
296 wxPrintData& GetPrintData() { return m_printData; }
297 void SetPrintData(const wxPrintData& data);
298
fa034c45 299private:
fa034c45
RR
300 wxPrintData m_printData;
301 PangoContext *m_context;
302 PangoLayout *m_layout;
303 PangoFontDescription *m_fontdesc;
304 cairo_t *m_cairo;
305
306 unsigned char m_currentRed;
307 unsigned char m_currentGreen;
308 unsigned char m_currentBlue;
309 unsigned char m_currentAlpha;
310
a9312950
RR
311 GtkPrintContext *m_gpc;
312 int m_resolution;
313 double m_PS2DEV;
314 double m_DEV2PS;
315
888dde65 316 DECLARE_DYNAMIC_CLASS(wxGtkPrinterDCImpl)
c0c133e1 317 wxDECLARE_NO_COPY_CLASS(wxGtkPrinterDCImpl);
fa034c45
RR
318};
319
320// ----------------------------------------------------------------------------
321// wxGtkPrintPreview: programmer creates an object of this class to preview a
322// wxPrintout.
323// ----------------------------------------------------------------------------
324
325class WXDLLIMPEXP_CORE wxGtkPrintPreview : public wxPrintPreviewBase
326{
327public:
328 wxGtkPrintPreview(wxPrintout *printout,
d3b9f782
VZ
329 wxPrintout *printoutForPrinting = NULL,
330 wxPrintDialogData *data = NULL);
fa034c45
RR
331 wxGtkPrintPreview(wxPrintout *printout,
332 wxPrintout *printoutForPrinting,
333 wxPrintData *data);
334
335 virtual ~wxGtkPrintPreview();
336
337 virtual bool Print(bool interactive);
338 virtual void DetermineScaling();
339
340private:
115be92b
VZ
341 void Init(wxPrintout *printout,
342 wxPrintout *printoutForPrinting,
343 wxPrintData *data);
344
345 // resolution to use in DPI
346 int m_resolution;
fa034c45
RR
347
348 DECLARE_CLASS(wxGtkPrintPreview)
349};
350
115be92b 351#endif // wxUSE_GTKPRINT
fa034c45 352
115be92b 353#endif // _WX_GTK_PRINT_H_