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 8eb1e3764ba9502138559b57377ae1c4e84702bf..b0f5a70c52d3ecbb35054be30fb5ea779f8a4846 100644 (file)
--- a/interface/wx/print.h
+++ b/interface/wx/print.h
@@ -6,6 +6,37 @@
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 // 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
 


@@ -195,21 +226,44 @@ public:
     virtual void CreateControlBar();
 
     /**
     virtual void CreateControlBar();
 
     /**

-        Creates the preview canvas and control bar.
+        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();
+
+    /**
+        Initializes the frame elements and prepares for showing it with the
+        given modality kind.

 
 

-        By default also disables the other existing top level windows to
-        prepare for showing the preview frame modally. Since wxWidgets 2.9.2
-        this can be changed by specifying either wxPreviewFrame_WindowModal --
-        to disable just the parent window -- or wxPreviewFrame_NonModal -- to
-        not disable any windows at all -- as @a kind parameter.
+        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.

 
 

-        This function must be called by the application prior to showing the frame.
+        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.

 
         @param kind
 
         @param kind

-            The modality kind of preview frame. @since 2.9.2
+            The modality kind of preview frame.
+
+        @since 2.9.2

     */
     */

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

 
     /**
         Enables any disabled frames in the application, and deletes the print preview
 
     /**
         Enables any disabled frames in the application, and deletes the print preview


@@ -259,8 +313,8 @@ 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.


@@ -268,6 +322,9 @@ public:
     wxPrintPreview(wxPrintout* printout,
                    wxPrintout* printoutForPrinting = NULL,
                    wxPrintDialogData* data = NULL);
     wxPrintPreview(wxPrintout* printout,
                    wxPrintout* printoutForPrinting = NULL,
                    wxPrintDialogData* data = NULL);

+    wxPrintPreview(wxPrintout* printout,
+                   wxPrintout* printoutForPrinting,
+                   wxPrintData* data);

 
     /**
         Destructor.
 
     /**
         Destructor.


@@ -275,7 +332,7 @@ 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.


@@ -618,10 +675,6 @@ 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).
         @beginWxPerlOnly
         In wxPerl this method takes no arguments and returns a
         2-element list (w, h).


@@ -638,10 +691,6 @@ 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).
         @beginWxPerlOnly
         In wxPerl this method takes no arguments and returns a
         2-element list (w, h).


@@ -659,12 +708,6 @@ 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

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


@@ -672,10 +715,6 @@ public:
     /**
         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).
         @beginWxPerlOnly
         In wxPerl this method takes no arguments and returns a
         2-element list (w, h).


@@ -692,15 +731,6 @@ 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
-
-        @beginWxPerlOnly
-        In wxPerl this method takes no arguments and returns a
-        2-element list (w, h).
-        @endWxPerlOnly

     */
     void GetPageSizePixels(int* w, int* h) const;
 
     */
     void GetPageSizePixels(int* w, int* h) const;
 


@@ -823,11 +853,6 @@ 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

     */
     virtual bool OnBeginDocument(int startPage, int endPage);
 
     */
     virtual bool OnBeginDocument(int startPage, int endPage);