synchronize GTK2 minimum version in docs

[wxWidgets.git] / interface / wx / print.h

diff --git a/interface/wx/print.h b/interface/wx/print.h
index 8ad4c4512b404b2c7a1c5a6a01df77a0dd5df0d0..b0f5a70c52d3ecbb35054be30fb5ea779f8a4846 100644 (file)
--- a/interface/wx/print.h
+++ b/interface/wx/print.h
@@ -3,12 +3,42 @@
 // Purpose:     interface of wxPreviewControlBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxPreviewControlBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+enum wxPrinterError
+{
+    wxPRINTER_NO_ERROR = 0,
+    wxPRINTER_CANCELLED,
+    wxPRINTER_ERROR
+};
+
+#define wxPREVIEW_PRINT        1
+#define wxPREVIEW_PREVIOUS     2
+#define wxPREVIEW_NEXT         4
+#define wxPREVIEW_ZOOM         8
+#define wxPREVIEW_FIRST       16
+#define wxPREVIEW_LAST        32
+#define wxPREVIEW_GOTO        64
+
+#define wxPREVIEW_DEFAULT  (wxPREVIEW_PREVIOUS|wxPREVIEW_NEXT|wxPREVIEW_ZOOM\
+                            |wxPREVIEW_FIRST|wxPREVIEW_GOTO|wxPREVIEW_LAST)
+
+// Ids for controls
+#define wxID_PREVIEW_CLOSE      1
+#define wxID_PREVIEW_NEXT       2
+#define wxID_PREVIEW_PREVIOUS   3
+#define wxID_PREVIEW_PRINT      4
+#define wxID_PREVIEW_ZOOM       5
+#define wxID_PREVIEW_FIRST      6
+#define wxID_PREVIEW_LAST       7
+#define wxID_PREVIEW_GOTO       8
+#define wxID_PREVIEW_ZOOM_IN    9
+#define wxID_PREVIEW_ZOOM_OUT   10
+
+

 /**
     @class wxPreviewControlBar
 /**
     @class wxPreviewControlBar

-    @wxheader{print.h}

 
     This is the default implementation of the preview control bar, a panel
     with buttons and a zoom control.
 
     This is the default implementation of the preview control bar, a panel
     with buttons and a zoom control.


@@ -56,29 +86,29 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxPreviewControlBar();
+    virtual ~wxPreviewControlBar();

 
     /**
         Creates buttons, according to value of the button style flags.
 
         @todo which flags??
     */
 
     /**
         Creates buttons, according to value of the button style flags.
 
         @todo which flags??
     */

-    void CreateButtons();
+    virtual void CreateButtons();

 
     /**
         Gets the print preview object associated with the control bar.
     */
 
     /**
         Gets the print preview object associated with the control bar.
     */

-    wxPrintPreview* GetPrintPreview();
+    virtual wxPrintPreviewBase* GetPrintPreview() const;

 
     /**
         Gets the current zoom setting in percent.
     */
 
     /**
         Gets the current zoom setting in percent.
     */

-    int GetZoomControl();
+    virtual int GetZoomControl();

 
     /**
         Sets the zoom control.
     */
 
     /**
         Sets the zoom control.
     */

-    void SetZoomControl(int percent);
+    virtual void SetZoomControl(int percent);

 
 };
 
 
 };
 


@@ -86,7 +116,6 @@ public:
 
 /**
     @class wxPreviewCanvas
 
 /**
     @class wxPreviewCanvas

-    @wxheader{print.h}

 
     A preview canvas is the default canvas used by the print preview
     system to display the preview.
 
     A preview canvas is the default canvas used by the print preview
     system to display the preview.


@@ -111,7 +140,7 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxPreviewCanvas();
+    virtual ~wxPreviewCanvas();

 
     /**
         Calls wxPrintPreview::PaintPage() to refresh the canvas.
 
     /**
         Calls wxPrintPreview::PaintPage() to refresh the canvas.


@@ -119,11 +148,36 @@ public:
     void OnPaint(wxPaintEvent& event);
 };
 
     void OnPaint(wxPaintEvent& event);
 };
 

+/**
+    Preview frame modality kind.

 
 

+    The elements of this enum can be used with wxPreviewFrame::Initialize() to
+    indicate how should the preview frame be shown.
+
+    @since 2.9.2
+*/
+enum wxPreviewFrameModalityKind
+{
+    /**
+        Disable all the other top level windows while the preview frame is shown.
+
+        This is the default behaviour.
+     */
+    wxPreviewFrame_AppModal,
+
+    /**
+        Disable only the parent window while the preview frame is shown.
+     */
+    wxPreviewFrame_WindowModal,
+
+    /**
+        Show the preview frame non-modally and don't disable any other windows.
+     */
+    wxPreviewFrame_NonModal
+};

 
 /**
     @class wxPreviewFrame
 
 /**
     @class wxPreviewFrame

-    @wxheader{print.h}

 
     This class provides the default method of managing the print preview interface.
     Member functions may be overridden to replace functionality, or the
 
     This class provides the default method of managing the print preview interface.
     Member functions may be overridden to replace functionality, or the


@@ -143,17 +197,17 @@ public:
         Pass a print preview object plus other normal frame arguments.
         The print preview object will be destroyed by the frame when it closes.
     */
         Pass a print preview object plus other normal frame arguments.
         The print preview object will be destroyed by the frame when it closes.
     */

-    wxPreviewFrame(wxPrintPreview* preview, wxWindow* parent,
-                   const wxString& title,
+    wxPreviewFrame(wxPrintPreviewBase* preview, wxWindow* parent,
+                   const wxString& title = "Print Preview",

                    const wxPoint& pos = wxDefaultPosition,
                    const wxPoint& pos = wxDefaultPosition,

-                   const wxSize& size size = wxDefaultSize,
+                   const wxSize& size = wxDefaultSize,

                    long style = wxDEFAULT_FRAME_STYLE,
                    long style = wxDEFAULT_FRAME_STYLE,

-                   const wxString& name = "frame");
+                   const wxString& name = wxFrameNameStr);

 
     /**
         Destructor.
     */
 
     /**
         Destructor.
     */

-    ~wxPreviewFrame();
+    virtual ~wxPreviewFrame();

 
     /**
         Creates a wxPreviewCanvas.
 
     /**
         Creates a wxPreviewCanvas.


@@ -161,7 +215,7 @@ public:
         Override this function to allow a user-defined preview canvas object
         to be created.
     */
         Override this function to allow a user-defined preview canvas object
         to be created.
     */

-    void CreateCanvas();
+    virtual void CreateCanvas();

 
     /**
         Creates a wxPreviewControlBar.
 
     /**
         Creates a wxPreviewControlBar.


@@ -169,18 +223,50 @@ public:
         Override this function to allow a user-defined preview control bar object
         to be created.
     */
         Override this function to allow a user-defined preview control bar object
         to be created.
     */

-    void CreateControlBar();
+    virtual void CreateControlBar();
+
+    /**
+        Initializes the frame elements and prepares for showing it.
+
+        Calling this method is equivalent to calling InitializeWithModality()
+        with wxPreviewFrame_AppModal argument, please see its documentation for
+        more details.
+
+        Please notice that this function is virtual mostly for backwards
+        compatibility only, there is no real need to override it as it's never
+        called by wxWidgets itself.
+     */
+    virtual void Initialize();

 
     /**
 
     /**

-        Creates the preview canvas and control bar, and calls wxWindow::MakeModal(@true)
-        to disable other top-level windows in the application.
+        Initializes the frame elements and prepares for showing it with the
+        given modality kind.
+
+        This method creates the frame elements by calling CreateCanvas() and
+        CreateControlBar() methods (which may be overridden to customize them)
+        and prepares to show the frame according to the value of @a kind
+        parameter:
+            - If it is wxPreviewFrame_AppModal, all the other application
+            windows will be disabled when this frame is shown. This is the same
+            behaviour as that of simple Initialize().
+            - If it is wxPreviewFrame_WindowModal, only the parent window of
+            the preview frame will be disabled when it is shown.
+            - And if it is wxPreviewFrame_NonModal, no windows at all will be
+            disabled while the preview is shown.
+
+        Notice that this function (or Initialize()) must be called by the
+        application prior to showing the frame but you still must call @c
+        Show(true) to actually show it afterwards.

 
 

-        This function should be called by the application prior to showing the frame.
+        @param kind
+            The modality kind of preview frame.
+
+        @since 2.9.2

     */
     */

-    void Initialize();
+    virtual void InitializeWithModality(wxPreviewFrameModalityKind kind);

 
     /**
 
     /**

-        Enables the other frames in the application, and deletes the print preview
+        Enables any disabled frames in the application, and deletes the print preview

         object, implicitly deleting any printout objects associated with the print
         preview object.
     */
         object, implicitly deleting any printout objects associated with the print
         preview object.
     */


@@ -191,7 +277,6 @@ public:
 
 /**
     @class wxPrintPreview
 
 /**
     @class wxPrintPreview

-    @wxheader{print.h}

 
     Objects of this class manage the print preview process. The object is passed
     a wxPrintout object, and the wxPrintPreview object itself is passed to
 
     Objects of this class manage the print preview process. The object is passed
     a wxPrintout object, and the wxPrintPreview object itself is passed to


@@ -228,15 +313,18 @@ public:
         the preview frame so that the user can print directly from the preview interface.
 
         @remarks
         the preview frame so that the user can print directly from the preview interface.
 
         @remarks

-        Do not explicitly delete the printout objects once this destructor has been
-        called, since they will be deleted in the wxPrintPreview constructor.
+        Do not explicitly delete the printout objects once this constructor has been
+        called, since they will be deleted in the wxPrintPreview destructor.

         The same does not apply to the @a data argument.
 
         Use IsOk() to check whether the wxPrintPreview object was created correctly.
     */
         The same does not apply to the @a data argument.
 
         Use IsOk() to check whether the wxPrintPreview object was created correctly.
     */

+    wxPrintPreview(wxPrintout* printout,
+                   wxPrintout* printoutForPrinting = NULL,
+                   wxPrintDialogData* data = NULL);

     wxPrintPreview(wxPrintout* printout,
                    wxPrintout* printoutForPrinting,
     wxPrintPreview(wxPrintout* printout,
                    wxPrintout* printoutForPrinting,

-                   wxPrintData* data = NULL);
+                   wxPrintData* data);

 
     /**
         Destructor.
 
     /**
         Destructor.


@@ -244,45 +332,45 @@ public:
         Deletes both print preview objects, so do not destroy these objects
         in your application.
     */
         Deletes both print preview objects, so do not destroy these objects
         in your application.
     */

-    ~wxPrinter();
+    ~wxPrintPreview();

 
     /**
         Gets the preview window used for displaying the print preview image.
     */
 
     /**
         Gets the preview window used for displaying the print preview image.
     */

-    wxPreviewCanvas* GetCanvas();
+    virtual wxPreviewCanvas* GetCanvas() const;

 
     /**
         Gets the page currently being previewed.
     */
 
     /**
         Gets the page currently being previewed.
     */

-    int GetCurrentPage();
+    virtual int GetCurrentPage() const;

 
     /**
         Gets the frame used for displaying the print preview canvas
         and control bar.
     */
 
     /**
         Gets the frame used for displaying the print preview canvas
         and control bar.
     */

-    wxFrame* GetFrame();
+    virtual wxFrame* GetFrame() const;

 
     /**
         Returns the maximum page number.
     */
 
     /**
         Returns the maximum page number.
     */

-    int GetMaxPage();
+    virtual int GetMaxPage() const;

 
     /**
         Returns the minimum page number.
     */
 
     /**
         Returns the minimum page number.
     */

-    int GetMinPage();
+    virtual int GetMinPage() const;

 
     /**
         Gets the preview printout object associated with the wxPrintPreview object.
     */
 
     /**
         Gets the preview printout object associated with the wxPrintPreview object.
     */

-    wxPrintout* GetPrintout();
+    virtual wxPrintout* GetPrintout() const;

 
     /**
         Gets the printout object to be used for printing from within the preview
         interface,
         or @NULL if none exists.
     */
 
     /**
         Gets the printout object to be used for printing from within the preview
         interface,
         or @NULL if none exists.
     */

-    wxPrintout* GetPrintoutForPrinting();
+    virtual wxPrintout* GetPrintoutForPrinting() const;

 
     /**
         Returns @true if the wxPrintPreview is valid, @false otherwise.
 
     /**
         Returns @true if the wxPrintPreview is valid, @false otherwise.


@@ -290,7 +378,7 @@ public:
         It could return @false if there was a problem initializing the printer
         device context (current printer not set, for example).
     */
         It could return @false if there was a problem initializing the printer
         device context (current printer not set, for example).
     */

-    bool IsOk();
+    virtual bool IsOk() const;

 
     /**
         This refreshes the preview window with the preview image.
 
     /**
         This refreshes the preview window with the preview image.


@@ -299,7 +387,7 @@ public:
         The implementation simply blits the preview bitmap onto
         the canvas, creating a new preview bitmap if none exists.
     */
         The implementation simply blits the preview bitmap onto
         the canvas, creating a new preview bitmap if none exists.
     */

-    bool PaintPage(wxPreviewCanvas* canvas, wxDC dc);
+    virtual bool PaintPage(wxPreviewCanvas* canvas, wxDC& dc);

 
     /**
         Invokes the print process using the second wxPrintout object
 
     /**
         Invokes the print process using the second wxPrintout object


@@ -310,45 +398,44 @@ public:
         Returns @false in case of error -- call wxPrinter::GetLastError()
         to get detailed information about the kind of the error.
     */
         Returns @false in case of error -- call wxPrinter::GetLastError()
         to get detailed information about the kind of the error.
     */

-    bool Print(bool prompt);
+    virtual bool Print(bool prompt);

 
     /**
         Renders a page into a wxMemoryDC. Used internally by wxPrintPreview.
     */
 
     /**
         Renders a page into a wxMemoryDC. Used internally by wxPrintPreview.
     */

-    bool RenderPage(int pageNum);
+    virtual bool RenderPage(int pageNum);

 
     /**
         Sets the window to be used for displaying the print preview image.
     */
 
     /**
         Sets the window to be used for displaying the print preview image.
     */

-    void SetCanvas(wxPreviewCanvas* window);
+    virtual void SetCanvas(wxPreviewCanvas* window);

 
     /**
         Sets the current page to be previewed.
     */
 
     /**
         Sets the current page to be previewed.
     */

-    void SetCurrentPage(int pageNum);
+    virtual bool SetCurrentPage(int pageNum);

 
     /**
         Sets the frame to be used for displaying the print preview canvas
         and control bar.
     */
 
     /**
         Sets the frame to be used for displaying the print preview canvas
         and control bar.
     */

-    void SetFrame(wxFrame* frame);
+    virtual void SetFrame(wxFrame* frame);

 
     /**
         Associates a printout object with the wxPrintPreview object.
     */
 
     /**
         Associates a printout object with the wxPrintPreview object.
     */

-    void SetPrintout(wxPrintout* printout);
+    virtual void SetPrintout(wxPrintout* printout);

 
     /**
         Sets the percentage preview zoom, and refreshes the preview canvas accordingly.
     */
 
     /**
         Sets the percentage preview zoom, and refreshes the preview canvas accordingly.
     */

-    void SetZoom(int percent);
+    virtual void SetZoom(int percent);

 };
 
 
 
 /**
     @class wxPrinter
 };
 
 
 
 /**
     @class wxPrinter

-    @wxheader{print.h}

 
     This class represents the Windows or PostScript printer, and is the vehicle
     through which printing may be launched by an application.
 
     This class represents the Windows or PostScript printer, and is the vehicle
     through which printing may be launched by an application.


@@ -378,12 +465,12 @@ public:
     /**
         Creates the default printing abort window, with a cancel button.
     */
     /**
         Creates the default printing abort window, with a cancel button.
     */

-    void CreateAbortWindow(wxWindow* parent, wxPrintout* printout);
+    virtual wxWindow* CreateAbortWindow(wxWindow* parent, wxPrintout* printout);

 
     /**
         Returns @true if the user has aborted the print job.
     */
 
     /**
         Returns @true if the user has aborted the print job.
     */

-    bool GetAbort();
+    bool GetAbort() const;

 
     /**
         Return last error. Valid after calling Print(), PrintDialog() or
 
     /**
         Return last error. Valid after calling Print(), PrintDialog() or


@@ -405,7 +492,7 @@ public:
         Returns the @ref overview_printing_printdata "print data" associated with
         the printer object.
     */
         Returns the @ref overview_printing_printdata "print data" associated with
         the printer object.
     */

-    wxPrintDialogData& GetPrintDialogData();
+    virtual wxPrintDialogData& GetPrintDialogData() const;

 
     /**
         Starts the printing process. Provide a parent window, a user-defined wxPrintout
 
     /**
         Starts the printing process. Provide a parent window, a user-defined wxPrintout


@@ -416,8 +503,8 @@ public:
         context (current printer not set, for example) or the user cancelled printing.
         Call GetLastError() to get detailed information about the kind of the error.
     */
         context (current printer not set, for example) or the user cancelled printing.
         Call GetLastError() to get detailed information about the kind of the error.
     */

-    bool Print(wxWindow* parent, wxPrintout* printout,
-               bool prompt = true);
+    virtual bool Print(wxWindow* parent, wxPrintout* printout,
+                       bool prompt = true);

 
     /**
         Invokes the print dialog.
 
     /**
         Invokes the print dialog.


@@ -429,13 +516,13 @@ public:
         @remarks
         The application must delete this device context to avoid a memory leak.
     */
         @remarks
         The application must delete this device context to avoid a memory leak.
     */

-    wxDC* PrintDialog(wxWindow* parent);
+    virtual wxDC* PrintDialog(wxWindow* parent);

 
     /**
         Default error-reporting function.
     */
 
     /**
         Default error-reporting function.
     */

-    void ReportError(wxWindow* parent, wxPrintout* printout,
-                     const wxString& message);
+    virtual void ReportError(wxWindow* parent, wxPrintout* printout,
+                             const wxString& message);

 
     /**
         Invokes the print setup dialog.
 
     /**
         Invokes the print setup dialog.


@@ -444,14 +531,13 @@ public:
         The setup dialog is obsolete from Windows 95, though retained
         for backward compatibility.
     */
         The setup dialog is obsolete from Windows 95, though retained
         for backward compatibility.
     */

-    bool Setup(wxWindow* parent);
+    virtual bool Setup(wxWindow* parent);

 };
 
 
 
 /**
     @class wxPrintout
 };
 
 
 
 /**
     @class wxPrintout

-    @wxheader{print.h}

 
     This class encapsulates the functionality of printing out an application document.
 
 
     This class encapsulates the functionality of printing out an application document.
 


@@ -496,7 +582,7 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxPrintout();
+    virtual ~wxPrintout();

 
     /**
         Set the user scale and device origin of the wxDC associated with this wxPrintout
 
     /**
         Set the user scale and device origin of the wxDC associated with this wxPrintout


@@ -550,7 +636,7 @@ public:
         This will be a wxPrinterDC if printing under Windows or Mac, a wxPostScriptDC
         if printing on other platforms, and a wxMemoryDC if previewing.
     */
         This will be a wxPrinterDC if printing under Windows or Mac, a wxPostScriptDC
         if printing on other platforms, and a wxMemoryDC if previewing.
     */

-    wxDC* GetDC();
+    wxDC* GetDC() const;

 
     /**
         Return the rectangle corresponding to the page margins specified by the given
 
     /**
         Return the rectangle corresponding to the page margins specified by the given


@@ -560,7 +646,7 @@ public:
         The page margins are specified with respect to the edges of the paper on all
         platforms.
     */
         The page margins are specified with respect to the edges of the paper on all
         platforms.
     */

-    wxRect GetLogicalPageMarginsRect(const wxPageSetupDialogData& pageSetupData);
+    wxRect GetLogicalPageMarginsRect(const wxPageSetupDialogData& pageSetupData) const;

 
     /**
         Return the rectangle corresponding to the page in the associated wxDC 's
 
     /**
         Return the rectangle corresponding to the page in the associated wxDC 's


@@ -570,13 +656,13 @@ public:
         On other platforms and PostScript printing, this will be the full paper
         rectangle.
     */
         On other platforms and PostScript printing, this will be the full paper
         rectangle.
     */

-    wxRect GetLogicalPageRect();
+    wxRect GetLogicalPageRect() const;

 
     /**
         Return the rectangle corresponding to the paper in the associated wxDC 's
         logical coordinates for the current user scale and device origin.
     */
 
     /**
         Return the rectangle corresponding to the paper in the associated wxDC 's
         logical coordinates for the current user scale and device origin.
     */

-    wxRect GetLogicalPaperRect();
+    wxRect GetLogicalPaperRect() const;

 
     /**
         Returns the number of pixels per logical inch of the printer device context.
 
     /**
         Returns the number of pixels per logical inch of the printer device context.


@@ -589,11 +675,12 @@ public:
         Or you can just use the FitThisSizeToXXX() and MapScreenSizeToXXX routines below,
         which do most of the scaling calculations for you.
 
         Or you can just use the FitThisSizeToXXX() and MapScreenSizeToXXX routines below,
         which do most of the scaling calculations for you.
 

-        @beginWxPythonOnly
-        This method returns the output-only parameters as a tuple.
-        @endWxPythonOnly
+        @beginWxPerlOnly
+        In wxPerl this method takes no arguments and returns a
+        2-element list (w, h).
+        @endWxPerlOnly

     */
     */

-    void GetPPIPrinter(int* w, int* h);
+    void GetPPIPrinter(int* w, int* h) const;

 
     /**
         Returns the number of pixels per logical inch of the screen device context.
 
     /**
         Returns the number of pixels per logical inch of the screen device context.


@@ -604,11 +691,12 @@ public:
         If you are doing your own scaling, remember to multiply this by a scaling
         factor to take the preview DC size into account.
 
         If you are doing your own scaling, remember to multiply this by a scaling
         factor to take the preview DC size into account.
 

-        @beginWxPythonOnly
-        This method returns the output-only parameters as a tuple.
-        @endWxPythonOnly
+        @beginWxPerlOnly
+        In wxPerl this method takes no arguments and returns a
+        2-element list (w, h).
+        @endWxPerlOnly

     */
     */

-    void GetPPIScreen(int* w, int* h);
+    void GetPPIScreen(int* w, int* h) const;

 
     /**
         Called by the framework to obtain information from the application about minimum
 
     /**
         Called by the framework to obtain information from the application about minimum


@@ -620,24 +708,19 @@ public:
 
         @a minPage must be greater than zero and @a maxPage must be greater
         than @a minPage.
 
         @a minPage must be greater than zero and @a maxPage must be greater
         than @a minPage.

-
-        @beginWxPythonOnly
-        When this method is implemented in a derived Python class, it should be designed
-        to take no parameters (other than the self reference) and to return a tuple of
-        four integers.
-        @endWxPythonOnly

     */
     */

-    void GetPageInfo(int* minPage, int* maxPage, int* pageFrom,
-                     int* pageTo);
+    virtual void GetPageInfo(int* minPage, int* maxPage, int* pageFrom,
+                             int* pageTo);

 
     /**
         Returns the size of the printer page in millimetres.
 
 
     /**
         Returns the size of the printer page in millimetres.
 

-        @beginWxPythonOnly
-        This method returns the output-only parameters as a tuple.
-        @endWxPythonOnly
+        @beginWxPerlOnly
+        In wxPerl this method takes no arguments and returns a
+        2-element list (w, h).
+        @endWxPerlOnly

     */
     */

-    void GetPageSizeMM(int* w, int* h);
+    void GetPageSizeMM(int* w, int* h) const;

 
     /**
         Returns the size of the printer page in pixels, called the page rectangle.
 
     /**
         Returns the size of the printer page in pixels, called the page rectangle.


@@ -648,12 +731,8 @@ public:
         previewing, a memory device context is used, which uses a bitmap size reflecting
         the current preview zoom. The application must take this discrepancy into
         account if previewing is to be supported.
         previewing, a memory device context is used, which uses a bitmap size reflecting
         the current preview zoom. The application must take this discrepancy into
         account if previewing is to be supported.

-
-        @beginWxPythonOnly
-        This method returns the output-only parameters as a tuple.
-        @endWxPythonOnly

     */
     */

-    void GetPageSizePixels(int* w, int* h);
+    void GetPageSizePixels(int* w, int* h) const;

 
     /**
         Returns the rectangle that corresponds to the entire paper in pixels, called the
 
     /**
         Returns the rectangle that corresponds to the entire paper in pixels, called the


@@ -674,14 +753,14 @@ public:
         area were printable, so this function will return the same rectangle as the page
         rectangle.
     */
         area were printable, so this function will return the same rectangle as the page
         rectangle.
     */

-    wxRect GetPaperRectPixels();
+    wxRect GetPaperRectPixels() const;

 
     /**
         Returns the title of the printout.
 
         @todo the python note here was wrong
     */
 
     /**
         Returns the title of the printout.
 
         @todo the python note here was wrong
     */

-    wxString GetTitle();
+    virtual wxString GetTitle() const;

 
     /**
         Should be overridden to return @true if the document has this page, or @false
 
     /**
         Should be overridden to return @true if the document has this page, or @false


@@ -690,12 +769,29 @@ public:
         Returning @false signifies the end of the document. By default,
         HasPage behaves as if the document has only one page.
     */
         Returning @false signifies the end of the document. By default,
         HasPage behaves as if the document has only one page.
     */

-    bool HasPage(int pageNum);
+    virtual bool HasPage(int pageNum);

 
     /**
         Returns @true if the printout is currently being used for previewing.
 
     /**
         Returns @true if the printout is currently being used for previewing.

+
+        @see GetPreview()

     */
     */

-    bool IsPreview();
+    virtual bool IsPreview() const;
+
+    /**
+        Returns the associated preview object if any.
+
+        If this printout object is used for previewing, returns the associated
+        wxPrintPreview. Otherwise returns @NULL.
+
+        The returned pointer is not owned by the printout and must not be
+        deleted.
+
+        @see IsPreview()
+
+        @since 2.9.1.
+     */
+    wxPrintPreview *GetPreview() const;

 
     /**
         Set the user scale and device origin of the wxDC associated with this wxPrintout
 
     /**
         Set the user scale and device origin of the wxDC associated with this wxPrintout


@@ -716,14 +812,14 @@ public:
     void MapScreenSizeToDevice();
 
     /**
     void MapScreenSizeToDevice();
 
     /**

-        This sets the user scale of the wxDC assocated with this wxPrintout to the same
+        This sets the user scale of the wxDC associated with this wxPrintout to the same

         scale as MapScreenSizeToPaper() but sets the logical origin to the top left corner
         of the page rectangle.
     */
     void MapScreenSizeToPage();
 
     /**
         scale as MapScreenSizeToPaper() but sets the logical origin to the top left corner
         of the page rectangle.
     */
     void MapScreenSizeToPage();
 
     /**

-        This sets the user scale of the wxDC assocated with this wxPrintout to the same
+        This sets the user scale of the wxDC associated with this wxPrintout to the same

         scale as MapScreenSizeToPageMargins() but sets the logical origin to the top left
         corner of the page margins specified by the given wxPageSetupDialogData object.
     */
         scale as MapScreenSizeToPageMargins() but sets the logical origin to the top left
         corner of the page margins specified by the given wxPageSetupDialogData object.
     */


@@ -739,7 +835,7 @@ public:
         (It will, of course, be larger or smaller in the preview image, depending on the
         zoom factor.)
 
         (It will, of course, be larger or smaller in the preview image, depending on the
         zoom factor.)
 

-        Use this if you want WYSIWYG behavior, e.g., in a text editor.
+        Use this if you want WYSIWYG behaviour, e.g., in a text editor.

     */
     void MapScreenSizeToPaper();
 
     */
     void MapScreenSizeToPaper();
 


@@ -757,13 +853,8 @@ public:
         @remarks
         The base OnBeginDocument() must be called (and the return value
         checked) from within the overridden function, since it calls wxDC::StartDoc().
         @remarks
         The base OnBeginDocument() must be called (and the return value
         checked) from within the overridden function, since it calls wxDC::StartDoc().

-
-        @beginWxPythonOnly
-         If this method is overridden in a Python class then the base class version can
-         be called by using the method <tt>base_OnBeginDocument(startPage, endPage)</tt>.
-        @endWxPythonOnly

     */
     */

-    bool OnBeginDocument(int startPage, int endPage);
+    virtual bool OnBeginDocument(int startPage, int endPage);

 
     /**
         Called by the framework at the start of printing.
 
     /**
         Called by the framework at the start of printing.


@@ -771,7 +862,7 @@ public:
         OnBeginPrinting() is called once for every print job
         (regardless of how many copies are being printed).
     */
         OnBeginPrinting() is called once for every print job
         (regardless of how many copies are being printed).
     */

-    void OnBeginPrinting();
+    virtual void OnBeginPrinting();

 
     /**
         Called by the framework at the end of document printing.
 
     /**
         Called by the framework at the end of document printing.


@@ -782,7 +873,7 @@ public:
         The base OnEndDocument() must be called from within the overridden function,
         since it calls wxDC::EndDoc().
     */
         The base OnEndDocument() must be called from within the overridden function,
         since it calls wxDC::EndDoc().
     */

-    void OnEndDocument();
+    virtual void OnEndDocument();

 
     /**
         Called by the framework at the end of printing.
 
     /**
         Called by the framework at the end of printing.


@@ -790,7 +881,7 @@ public:
         OnEndPrinting is called once for every print job
         (regardless of how many copies are being printed).
     */
         OnEndPrinting is called once for every print job
         (regardless of how many copies are being printed).
     */

-    void OnEndPrinting();
+    virtual void OnEndPrinting();

 
     /**
         Called once by the framework before any other demands are made of the
 
     /**
         Called once by the framework before any other demands are made of the


@@ -799,13 +890,13 @@ public:
         This gives the object an opportunity to calculate the number of pages
         in the document, for example.
     */
         This gives the object an opportunity to calculate the number of pages
         in the document, for example.
     */

-    void OnPreparePrinting();
+    virtual void OnPreparePrinting();

 
     /**
         Called by the framework when a page should be printed. Returning @false cancels
         the print job.
     */
 
     /**
         Called by the framework when a page should be printed. Returning @false cancels
         the print job.
     */

-    bool OnPrintPage(int pageNum);
+    virtual bool OnPrintPage(int pageNum) = 0;

 
     /**
         Set the device origin of the associated wxDC so that the current logical point
 
     /**
         Set the device origin of the associated wxDC so that the current logical point