Document that wxTreeCtrl::SelectItem() generates events.

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

diff --git a/interface/wx/print.h b/interface/wx/print.h
index 072ba8d84277c67bb4e253ec27077ba5e9862a2a..ad0ef0ea31e6494b1fcd9f81e9de7e957d5a07ac 100644 (file)
--- a/interface/wx/print.h
+++ b/interface/wx/print.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxPreviewControlBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -140,12 +140,12 @@ public:
         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 wxSize& size size = wxDefaultSize,
+                   const wxSize& size = wxDefaultSize,
                    long style = wxDEFAULT_FRAME_STYLE,
-                   const wxString& name = "frame");
+                   const wxString& name = wxFrameNameStr);
 
     /**
         Destructor.
@@ -231,8 +231,8 @@ public:
         Use IsOk() to check whether the wxPrintPreview object was created correctly.
     */
     wxPrintPreview(wxPrintout* printout,
-                   wxPrintout* printoutForPrinting,
-                   wxPrintData* data = NULL);
+                   wxPrintout* printoutForPrinting = NULL,
+                   wxPrintDialogData* data = NULL);
 
     /**
         Destructor.
@@ -295,7 +295,7 @@ public:
         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
@@ -321,7 +321,7 @@ public:
     /**
         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
@@ -373,7 +373,7 @@ public:
     /**
         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.
@@ -411,8 +411,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.
     */
-    bool Print(wxWindow* parent, wxPrintout* printout,
-               bool prompt = true);
+    virtual bool Print(wxWindow* parent, wxPrintout* printout,
+                       bool prompt = true);
 
     /**
         Invokes the print dialog.
@@ -429,8 +429,8 @@ public:
     /**
         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.
@@ -586,6 +586,11 @@ public:
         @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) const;
 
@@ -601,6 +606,11 @@ public:
         @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) const;
 
@@ -621,8 +631,8 @@ public:
         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.
@@ -630,6 +640,11 @@ public:
         @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) const;
 
@@ -646,6 +661,11 @@ public:
         @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;
 
@@ -688,9 +708,26 @@ public:
 
     /**
         Returns @true if the printout is currently being used for previewing.
+
+        @see GetPreview()
     */
     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
         so that one screen pixel maps to one device pixel on the DC.
@@ -710,14 +747,14 @@ public:
     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();
 
     /**
-        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.
     */
@@ -733,7 +770,7 @@ public:
         (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();