1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: SWIG interface for wx????
9 // Copyright: (c) 2003 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
16 //---------------------------------------------------------------------------
20 #include "wx/wxPython/printfw.h"
24 MAKE_CONST_WXSTRING2(PrintoutTitleStr, wxT("Printout"));
25 MAKE_CONST_WXSTRING2(PreviewCanvasNameStr, wxT("previewcanvas"));
28 //---------------------------------------------------------------------------
32 wxPRINT_MODE_NONE = 0,
33 wxPRINT_MODE_PREVIEW = 1, // Preview in external application
34 wxPRINT_MODE_FILE = 2, // Print to file
35 wxPRINT_MODE_PRINTER = 3, // Send to printer
36 wxPRINT_MODE_STREAM = 4 // Send postscript data into a stream
53 wxPRINTBIN_LARGECAPACITY,
55 wxPRINTBIN_FORMSOURCE,
61 class wxPrintData : public wxObject {
63 %nokwargs wxPrintData;
65 wxPrintData(const wxPrintData& data); // for making copies
75 const wxString& GetPrinterName();
77 wxDuplexMode GetDuplex();
78 wxPaperSize GetPaperId();
79 const wxSize& GetPaperSize();
83 wxPrintMode GetPrintMode() const;
85 void SetNoCopies(int v);
86 void SetCollate(bool flag);
87 void SetOrientation(int orient);
89 void SetPrinterName(const wxString& name);
90 void SetColour(bool colour);
91 void SetDuplex(wxDuplexMode duplex);
92 void SetPaperId(wxPaperSize sizeId);
93 void SetPaperSize(const wxSize& sz);
94 void SetQuality(int quality);
95 void SetBin(wxPrintBin bin);
96 void SetPrintMode(wxPrintMode printMode);
98 wxString GetFilename() const;
99 void SetFilename( const wxString &filename );
101 %pythoncode { def __nonzero__(self): return self.Ok() }
104 // NOTE: These are now inside of #if WXWIN_COMPATIBILITY_2_4, so be
105 // prepared to remove them...
107 // PostScript-specific data
108 const wxString& GetPrinterCommand();
109 const wxString& GetPrinterOptions();
110 const wxString& GetPreviewCommand();
111 const wxString& GetFontMetricPath();
112 double GetPrinterScaleX();
113 double GetPrinterScaleY();
114 long GetPrinterTranslateX();
115 long GetPrinterTranslateY();
116 void SetPrinterCommand(const wxString& command);
117 void SetPrinterOptions(const wxString& options);
118 void SetPreviewCommand(const wxString& command);
119 void SetFontMetricPath(const wxString& path);
120 void SetPrinterScaleX(double x);
121 void SetPrinterScaleY(double y);
122 void SetPrinterScaling(double x, double y);
123 void SetPrinterTranslateX(long x);
124 void SetPrinterTranslateY(long y);
125 void SetPrinterTranslation(long x, long y);
129 //---------------------------------------------------------------------------
131 class wxPageSetupDialogData : public wxObject {
133 %nokwargs wxPageSetupDialogData;
134 wxPageSetupDialogData();
135 wxPageSetupDialogData(const wxPageSetupDialogData& data); // for making copies
136 ~wxPageSetupDialogData();
138 void EnableHelp(bool flag);
139 void EnableMargins(bool flag);
140 void EnableOrientation(bool flag);
141 void EnablePaper(bool flag);
142 void EnablePrinter(bool flag);
143 bool GetDefaultMinMargins();
144 bool GetEnableMargins();
145 bool GetEnableOrientation();
146 bool GetEnablePaper();
147 bool GetEnablePrinter();
148 bool GetEnableHelp();
149 bool GetDefaultInfo();
150 wxPoint GetMarginTopLeft();
151 wxPoint GetMarginBottomRight();
152 wxPoint GetMinMarginTopLeft();
153 wxPoint GetMinMarginBottomRight();
154 wxPaperSize GetPaperId();
155 wxSize GetPaperSize();
157 wxPrintData& GetPrintData();
159 // %new wxPrintData* GetPrintData() {
160 // return new wxPrintData(self->GetPrintData()); // force a copy
166 void SetDefaultInfo(bool flag);
167 void SetDefaultMinMargins(bool flag);
168 void SetMarginTopLeft(const wxPoint& pt);
169 void SetMarginBottomRight(const wxPoint& pt);
170 void SetMinMarginTopLeft(const wxPoint& pt);
171 void SetMinMarginBottomRight(const wxPoint& pt);
172 void SetPaperId(wxPaperSize id);
173 void SetPaperSize(const wxSize& size);
174 void SetPrintData(const wxPrintData& printData);
176 %pythoncode { def __nonzero__(self): return self.Ok() }
181 // NOTE: Contrary to it's name, this class doesn't derive from wxDialog. It
182 // is a facade in front of a platform-specific (native dialog) provided by the
185 MustHaveApp(wxPageSetupDialog);
187 class wxPageSetupDialog : public wxObject
190 wxPageSetupDialog(wxWindow* parent, wxPageSetupDialogData* data = NULL);
192 wxPageSetupDialogData& GetPageSetupData();
193 wxPageSetupDialogData& GetPageSetupDialogData();
197 //---------------------------------------------------------------------------
200 class wxPrintDialogData : public wxObject {
202 %nokwargs wxPrintDialogData;
204 wxPrintDialogData(const wxPrintData& printData); // for making copies
205 ~wxPrintDialogData();
207 int GetFromPage() const;
208 int GetToPage() const;
209 int GetMinPage() const;
210 int GetMaxPage() const;
211 int GetNoCopies() const;
212 bool GetAllPages() const;
213 bool GetSelection() const;
214 bool GetCollate() const;
215 bool GetPrintToFile() const;
217 // WXWIN_COMPATIBILITY_2_4
218 bool GetSetupDialog() const;
219 void SetSetupDialog(bool flag);
221 void SetFromPage(int v);
222 void SetToPage(int v);
223 void SetMinPage(int v);
224 void SetMaxPage(int v);
225 void SetNoCopies(int v);
226 void SetAllPages(bool flag);
227 void SetSelection(bool flag);
228 void SetCollate(bool flag);
229 void SetPrintToFile(bool flag);
231 void EnablePrintToFile(bool flag);
232 void EnableSelection(bool flag);
233 void EnablePageNumbers(bool flag);
234 void EnableHelp(bool flag);
236 bool GetEnablePrintToFile() const;
237 bool GetEnableSelection() const;
238 bool GetEnablePageNumbers() const;
239 bool GetEnableHelp() const;
241 // Is this data OK for showing the print dialog?
245 wxPrintData& GetPrintData();
246 void SetPrintData(const wxPrintData& printData);
248 %pythoncode { def __nonzero__(self): return self.Ok() }
253 MustHaveApp(wxPrintDialog);
256 // NOTE: Contrary to it's name, this class doesn't derive from wxDialog. It
257 // is a facade in front of a platform-specific (native dialog) provided by the
260 class wxPrintDialog : public wxObject {
262 wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);
264 // TODO?: wxPrintDialog(wxWindow *parent, wxPrintData* data);
266 virtual int ShowModal();
268 virtual wxPrintDialogData& GetPrintDialogData();
269 virtual wxPrintData& GetPrintData();
271 %newobject GetPrintDC;
272 virtual wxDC *GetPrintDC();
277 //---------------------------------------------------------------------------
278 //---------------------------------------------------------------------------
283 wxPRINTER_NO_ERROR = 0,
289 MustHaveApp(wxPrinter);
291 class wxPrinter : public wxObject {
293 wxPrinter(wxPrintDialogData* data = NULL);
296 virtual wxWindow *CreateAbortWindow(wxWindow *parent, wxPyPrintout *printout);
297 virtual void ReportError(wxWindow *parent, wxPyPrintout *printout, const wxString& message);
299 virtual bool Setup(wxWindow *parent);
300 virtual bool Print(wxWindow *parent, wxPyPrintout *printout, bool prompt = true);
301 virtual wxDC* PrintDialog(wxWindow *parent);
303 virtual wxPrintDialogData& GetPrintDialogData() const;
306 static wxPrinterError GetLastError();
310 //---------------------------------------------------------------------------
311 // Custom wxPrintout class that knows how to call python, See implementation in
312 // include/sx/wxPython/printfw.h
316 IMPLEMENT_ABSTRACT_CLASS(wxPyPrintout, wxPrintout);
318 // Since this one would be tough and ugly to do with the Macros...
319 void wxPyPrintout::GetPageInfo(int *minPage, int *maxPage, int *pageFrom, int *pageTo) {
323 bool blocked = wxPyBeginBlockThreads();
324 if ((found = wxPyCBH_findCallback(m_myInst, "GetPageInfo"))) {
325 PyObject* result = wxPyCBH_callCallbackObj(m_myInst, Py_BuildValue("()"));
326 if (result && PyTuple_Check(result) && PyTuple_Size(result) == 4) {
329 val = PyTuple_GetItem(result, 0);
330 if (PyInt_Check(val)) *minPage = PyInt_AsLong(val);
333 val = PyTuple_GetItem(result, 1);
334 if (PyInt_Check(val)) *maxPage = PyInt_AsLong(val);
337 val = PyTuple_GetItem(result, 2);
338 if (PyInt_Check(val)) *pageFrom = PyInt_AsLong(val);
341 val = PyTuple_GetItem(result, 3);
342 if (PyInt_Check(val)) *pageTo = PyInt_AsLong(val);
349 PyErr_SetString(PyExc_TypeError, "GetPageInfo should return a tuple of 4 integers.");
354 wxPyEndBlockThreads(blocked);
356 wxPrintout::GetPageInfo(minPage, maxPage, pageFrom, pageTo);
359 void wxPyPrintout::base_GetPageInfo(int *minPage, int *maxPage, int *pageFrom, int *pageTo) {
360 wxPrintout::GetPageInfo(minPage, maxPage, pageFrom, pageTo);
364 IMP_PYCALLBACK_BOOL_INTINT(wxPyPrintout, wxPrintout, OnBeginDocument);
365 IMP_PYCALLBACK__(wxPyPrintout, wxPrintout, OnEndDocument);
366 IMP_PYCALLBACK__(wxPyPrintout, wxPrintout, OnBeginPrinting);
367 IMP_PYCALLBACK__(wxPyPrintout, wxPrintout, OnEndPrinting);
368 IMP_PYCALLBACK__(wxPyPrintout, wxPrintout, OnPreparePrinting);
369 IMP_PYCALLBACK_BOOL_INT_pure(wxPyPrintout, wxPrintout, OnPrintPage);
370 IMP_PYCALLBACK_BOOL_INT(wxPyPrintout, wxPrintout, HasPage);
376 MustHaveApp(wxPyPrintout);
378 // Now define the custom class for SWIGging
379 %name(Printout) class wxPyPrintout : public wxObject {
381 %pythonAppend wxPyPrintout "self._setCallbackInfo(self, Printout)"
383 wxPyPrintout(const wxString& title = wxPyPrintoutTitleStr);
384 //~wxPyPrintout(); wxPrintPreview object takes ownership...
386 void _setCallbackInfo(PyObject* self, PyObject* _class);
389 wxString GetTitle() const;
391 void SetDC(wxDC *dc);
393 void SetPageSizePixels(int w, int h);
395 void, GetPageSizePixels(int *OUTPUT, int *OUTPUT),
396 "GetPageSizePixels() -> (w, h)");
398 void SetPageSizeMM(int w, int h);
400 void, GetPageSizeMM(int *OUTPUT, int *OUTPUT),
401 "GetPageSizeMM() -> (w, h)");
403 void SetPPIScreen(int x, int y);
405 void, GetPPIScreen(int *OUTPUT, int *OUTPUT),
406 "GetPPIScreen() -> (x,y)");
408 void SetPPIPrinter(int x, int y);
410 void, GetPPIPrinter(int *OUTPUT, int *OUTPUT),
411 "GetPPIPrinter() -> (x,y)");
414 void SetIsPreview(bool p);
417 bool base_OnBeginDocument(int startPage, int endPage);
418 void base_OnEndDocument();
419 void base_OnBeginPrinting();
420 void base_OnEndPrinting();
421 void base_OnPreparePrinting();
422 bool base_HasPage(int page);
424 void, base_GetPageInfo(int *OUTPUT, int *OUTPUT, int *OUTPUT, int *OUTPUT),
425 "base_GetPageInfo() -> (minPage, maxPage, pageFrom, pageTo)");
428 //---------------------------------------------------------------------------
432 MustHaveApp(wxPreviewCanvas);
434 class wxPreviewCanvas: public wxScrolledWindow
437 %pythonAppend wxPreviewCanvas "self._setOORInfo(self)"
439 wxPreviewCanvas(wxPrintPreview *preview,
441 const wxPoint& pos = wxDefaultPosition,
442 const wxSize& size = wxDefaultSize,
444 const wxString& name = wxPyPreviewCanvasNameStr);
448 MustHaveApp(wxPreviewFrame);
450 class wxPreviewFrame : public wxFrame {
452 %pythonAppend wxPreviewFrame "self._setOORInfo(self)"
454 wxPreviewFrame(wxPrintPreview* preview, wxFrame* parent, const wxString& title,
455 const wxPoint& pos = wxDefaultPosition,
456 const wxSize& size = wxDefaultSize,
457 long style = wxDEFAULT_FRAME_STYLE,
458 const wxString& name = wxPyFrameNameStr);
461 void CreateControlBar();
464 wxPreviewControlBar* GetControlBar() const;
481 wxID_PREVIEW_PREVIOUS,
489 MustHaveApp(wxPreviewControlBar);
491 class wxPreviewControlBar: public wxPanel
494 %pythonAppend wxPreviewControlBar "self._setOORInfo(self)"
496 wxPreviewControlBar(wxPrintPreview *preview,
499 const wxPoint& pos = wxDefaultPosition,
500 const wxSize& size = wxDefaultSize,
501 long style = wxTAB_TRAVERSAL,
502 const wxString& name = wxPyPanelNameStr);
504 int GetZoomControl();
505 void SetZoomControl(int zoom);
506 wxPrintPreview* GetPrintPreview();
517 //---------------------------------------------------------------------------
519 MustHaveApp(wxPrintPreview);
521 class wxPrintPreview : public wxObject {
523 %nokwargs wxPrintPreview;
524 wxPrintPreview(wxPyPrintout* printout,
525 wxPyPrintout* printoutForPrinting,
526 wxPrintDialogData *data=NULL);
527 wxPrintPreview(wxPyPrintout* printout,
528 wxPyPrintout* printoutForPrinting,
531 virtual bool SetCurrentPage(int pageNum);
532 int GetCurrentPage();
534 void SetPrintout(wxPyPrintout *printout);
535 wxPyPrintout *GetPrintout();
536 wxPyPrintout *GetPrintoutForPrinting();
538 void SetFrame(wxFrame *frame);
539 void SetCanvas(wxPreviewCanvas *canvas);
541 virtual wxFrame *GetFrame();
542 virtual wxPreviewCanvas *GetCanvas();
544 // The preview canvas should call this from OnPaint
545 virtual bool PaintPage(wxPreviewCanvas *canvas, wxDC& dc);
547 // This draws a blank page onto the preview canvas
548 virtual bool DrawBlankPage(wxPreviewCanvas *canvas, wxDC& dc);
550 // This is called by wxPrintPreview to render a page into a wxMemoryDC.
551 virtual bool RenderPage(int pageNum);
553 // Adjusts the scrollbars for the current scale
554 virtual void AdjustScrollbars(wxPreviewCanvas *canvas);
556 wxPrintDialogData& GetPrintDialogData();
558 virtual void SetZoom(int percent);
567 virtual bool Print(bool interactive);
568 virtual void DetermineScaling();
570 %pythoncode { def __nonzero__(self): return self.Ok() }
575 //---------------------------------------------------------------------------
577 // Python-derivable versions of the above preview classes
581 #define DEC_PYCALLBACK_BOOL_PREWINDC(CBNAME) \
582 bool CBNAME(wxPreviewCanvas* a, wxDC& b); \
583 bool base_##CBNAME(wxPreviewCanvas* a, wxDC& b)
586 #define IMP_PYCALLBACK_BOOL_PREWINDC(CLASS, PCLASS, CBNAME) \
587 bool CLASS::CBNAME(wxPreviewCanvas* a, wxDC& b) { \
590 bool blocked = wxPyBeginBlockThreads(); \
591 if ((found = wxPyCBH_findCallback(m_myInst, #CBNAME))) { \
592 PyObject* win = wxPyMake_wxObject(a,false); \
593 PyObject* dc = wxPyMake_wxObject(&b,false); \
594 rval = wxPyCBH_callCallback(m_myInst, Py_BuildValue("(OO)", win, dc)); \
598 wxPyEndBlockThreads(blocked); \
600 rval = PCLASS::CBNAME(a, b); \
603 bool CLASS::base_##CBNAME(wxPreviewCanvas* a, wxDC& b) { \
604 return PCLASS::CBNAME(a, b); \
610 class wxPyPrintPreview : public wxPrintPreview
612 DECLARE_CLASS(wxPyPrintPreview)
614 wxPyPrintPreview(wxPyPrintout* printout,
615 wxPyPrintout* printoutForPrinting,
616 wxPrintDialogData* data=NULL)
617 : wxPrintPreview(printout, printoutForPrinting, data)
619 wxPyPrintPreview(wxPyPrintout* printout,
620 wxPyPrintout* printoutForPrinting,
621 wxPrintData* data=NULL)
622 : wxPrintPreview(printout, printoutForPrinting, data)
625 DEC_PYCALLBACK_BOOL_INT(SetCurrentPage);
626 DEC_PYCALLBACK_BOOL_PREWINDC(PaintPage);
627 DEC_PYCALLBACK_BOOL_PREWINDC(DrawBlankPage);
628 DEC_PYCALLBACK_BOOL_INT(RenderPage);
629 DEC_PYCALLBACK_VOID_INT(SetZoom);
630 DEC_PYCALLBACK_BOOL_BOOL(Print);
631 DEC_PYCALLBACK_VOID_(DetermineScaling);
636 // Stupid renamed classes... Fix this in 2.5...
637 #if defined(__WXMSW__)
638 IMPLEMENT_CLASS( wxPyPrintPreview, wxWindowsPrintPreview );
639 #elif defined(__WXMAC__)
640 IMPLEMENT_CLASS( wxPyPrintPreview, wxMacPrintPreview );
642 IMPLEMENT_CLASS( wxPyPrintPreview, wxPostScriptPrintPreview );
645 IMP_PYCALLBACK_BOOL_INT (wxPyPrintPreview, wxPrintPreview, SetCurrentPage);
646 IMP_PYCALLBACK_BOOL_PREWINDC(wxPyPrintPreview, wxPrintPreview, PaintPage);
647 IMP_PYCALLBACK_BOOL_PREWINDC(wxPyPrintPreview, wxPrintPreview, DrawBlankPage);
648 IMP_PYCALLBACK_BOOL_INT (wxPyPrintPreview, wxPrintPreview, RenderPage);
649 IMP_PYCALLBACK_VOID_INT (wxPyPrintPreview, wxPrintPreview, SetZoom);
650 IMP_PYCALLBACK_BOOL_BOOL (wxPyPrintPreview, wxPrintPreview, Print);
651 IMP_PYCALLBACK_VOID_ (wxPyPrintPreview, wxPrintPreview, DetermineScaling);
655 MustHaveApp(wxPyPrintPreview);
657 class wxPyPrintPreview : public wxPrintPreview
660 %pythonAppend wxPyPrintPreview "self._setCallbackInfo(self, PyPrintPreview)"
661 %nokwargs wxPyPrintPreview;
662 wxPyPrintPreview(wxPyPrintout* printout,
663 wxPyPrintout* printoutForPrinting,
664 wxPrintDialogData* data=NULL);
665 wxPyPrintPreview(wxPyPrintout* printout,
666 wxPyPrintout* printoutForPrinting,
669 void _setCallbackInfo(PyObject* self, PyObject* _class);
671 bool base_SetCurrentPage(int pageNum);
672 bool base_PaintPage(wxPreviewCanvas *canvas, wxDC& dc);
673 bool base_DrawBlankPage(wxPreviewCanvas *canvas, wxDC& dc);
674 bool base_RenderPage(int pageNum);
675 void base_SetZoom(int percent);
676 bool base_Print(bool interactive);
677 void base_DetermineScaling();
684 class wxPyPreviewFrame : public wxPreviewFrame
686 DECLARE_CLASS(wxPyPreviewFrame);
688 wxPyPreviewFrame(wxPrintPreview* preview, wxFrame* parent,
689 const wxString& title,
690 const wxPoint& pos = wxDefaultPosition,
691 const wxSize& size = wxDefaultSize,
692 long style = wxDEFAULT_FRAME_STYLE,
693 const wxString& name = wxPyFrameNameStr)
694 : wxPreviewFrame(preview, parent, title, pos, size, style, name)
697 void SetPreviewCanvas(wxPreviewCanvas* canvas) { m_previewCanvas = canvas; }
698 void SetControlBar(wxPreviewControlBar* bar) { m_controlBar = bar; }
700 DEC_PYCALLBACK_VOID_(Initialize);
701 DEC_PYCALLBACK_VOID_(CreateCanvas);
702 DEC_PYCALLBACK_VOID_(CreateControlBar);
707 IMPLEMENT_CLASS(wxPyPreviewFrame, wxPreviewFrame);
709 IMP_PYCALLBACK_VOID_(wxPyPreviewFrame, wxPreviewFrame, Initialize);
710 IMP_PYCALLBACK_VOID_(wxPyPreviewFrame, wxPreviewFrame, CreateCanvas);
711 IMP_PYCALLBACK_VOID_(wxPyPreviewFrame, wxPreviewFrame, CreateControlBar);
715 MustHaveApp(wxPyPreviewFrame);
717 class wxPyPreviewFrame : public wxPreviewFrame
720 %pythonAppend wxPyPreviewFrame "self._setCallbackInfo(self, PyPreviewFrame); self._setOORInfo(self)"
722 wxPyPreviewFrame(wxPrintPreview* preview, wxFrame* parent,
723 const wxString& title,
724 const wxPoint& pos = wxDefaultPosition,
725 const wxSize& size = wxDefaultSize,
726 long style = wxDEFAULT_FRAME_STYLE,
727 const wxString& name = wxPyFrameNameStr);
729 void _setCallbackInfo(PyObject* self, PyObject* _class);
731 void SetPreviewCanvas(wxPreviewCanvas* canvas);
732 void SetControlBar(wxPreviewControlBar* bar);
734 void base_Initialize();
735 void base_CreateCanvas();
736 void base_CreateControlBar();
743 class wxPyPreviewControlBar : public wxPreviewControlBar
745 DECLARE_CLASS(wxPyPreviewControlBar);
747 wxPyPreviewControlBar(wxPrintPreview *preview,
750 const wxPoint& pos = wxDefaultPosition,
751 const wxSize& size = wxDefaultSize,
753 const wxString& name = wxPyPanelNameStr)
754 : wxPreviewControlBar(preview, buttons, parent, pos, size, style, name)
757 void SetPrintPreview(wxPrintPreview* preview) { m_printPreview = preview; }
759 DEC_PYCALLBACK_VOID_(CreateButtons);
760 DEC_PYCALLBACK_VOID_INT(SetZoomControl);
765 IMPLEMENT_CLASS(wxPyPreviewControlBar, wxPreviewControlBar);
766 IMP_PYCALLBACK_VOID_(wxPyPreviewControlBar, wxPreviewControlBar, CreateButtons);
767 IMP_PYCALLBACK_VOID_INT(wxPyPreviewControlBar, wxPreviewControlBar, SetZoomControl);
771 MustHaveApp(wxPyPreviewControlBar);
773 class wxPyPreviewControlBar : public wxPreviewControlBar
776 %pythonAppend wxPyPreviewControlBar "self._setCallbackInfo(self, PyPreviewControlBar); self._setOORInfo(self)"
778 wxPyPreviewControlBar(wxPrintPreview *preview,
781 const wxPoint& pos = wxDefaultPosition,
782 const wxSize& size = wxDefaultSize,
784 const wxString& name = wxPyPanelNameStr);
786 void _setCallbackInfo(PyObject* self, PyObject* _class);
788 void SetPrintPreview(wxPrintPreview* preview);
790 void base_CreateButtons();
791 void base_SetZoomControl(int zoom);
794 //---------------------------------------------------------------------------
795 //---------------------------------------------------------------------------
797 wxPyPtrTypeMap_Add("wxPrintout", "wxPyPrintout");
799 //---------------------------------------------------------------------------