Applied patch #15286: documentation and col/rowspan demo by dghart

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

diff --git a/interface/wx/printdlg.h b/interface/wx/printdlg.h
index 4a174546bbd37beff288f9e825fefa0239f72fb1..630e03a0af3e7ee995730d3ff2d2f62878dfd82a 100644 (file)
--- a/interface/wx/printdlg.h
+++ b/interface/wx/printdlg.h
@@ -3,12 +3,11 @@
 // Purpose:     interface of wxPrintDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxPrintDialog
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

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

 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxPrintDialog
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxPrintDialog

-    @wxheader{printdlg.h}

 
     This class represents the print and print setup common dialogs.
     You may obtain a wxPrinterDC device context from a successfully dismissed
 
     This class represents the print and print setup common dialogs.
     You may obtain a wxPrinterDC device context from a successfully dismissed


@@ -19,7 +18,7 @@
 
     @see @ref overview_printing, @ref overview_cmndlg_print
 */
 
     @see @ref overview_printing, @ref overview_cmndlg_print
 */

-class wxPrintDialog : public wxDialog
+class wxPrintDialog : public wxObject

 {
 public:
     /**
 {
 public:
     /**


@@ -31,6 +30,7 @@ public:
         @see wxPrintDialogData
     */
     wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);
         @see wxPrintDialogData
     */
     wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);

+    wxPrintDialog(wxWindow *parent, wxPrintData* data);

 
     /**
         Destructor.
 
     /**
         Destructor.


@@ -38,7 +38,7 @@ public:
         If GetPrintDC() has not been called, the device context obtained by
         the dialog (if any) will be deleted.
     */
         If GetPrintDC() has not been called, the device context obtained by
         the dialog (if any) will be deleted.
     */

-    ~wxPrintDialog();
+    virtual ~wxPrintDialog();

 
     /**
         Returns the device context created by the print dialog, if any.
 
     /**
         Returns the device context created by the print dialog, if any.


@@ -47,13 +47,19 @@ public:
         is transferred to the application, so it must then be deleted
         explicitly.
     */
         is transferred to the application, so it must then be deleted
         explicitly.
     */

-    wxDC* GetPrintDC();
+    virtual wxDC* GetPrintDC();

 
     /**
         Returns the @ref overview_printing_printdata "print dialog data" associated
         with the print dialog.
     */
 
     /**
         Returns the @ref overview_printing_printdata "print dialog data" associated
         with the print dialog.
     */

-    wxPrintDialogData GetPrintDialogData();
+    virtual wxPrintDialogData& GetPrintDialogData();
+
+    /**
+       Returns the @ref overview_printing_printdata "print data" associated
+       with the print dialog.
+    */
+    virtual wxPrintData& GetPrintData();

 
     /**
         Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c
 
     /**
         Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c


@@ -62,29 +68,22 @@ public:
         After this function is called, a device context may be retrievable using
         GetPrintDC().
     */
         After this function is called, a device context may be retrievable using
         GetPrintDC().
     */

-    int ShowModal();
+    virtual int ShowModal();

 };
 
 
 
 /**
     @class wxPageSetupDialog
 };
 
 
 
 /**
     @class wxPageSetupDialog

-    @wxheader{printdlg.h}
-
-    This class represents the page setup common dialog. In MSW, the page setup
-    dialog is standard from Windows 95 on, replacing the print setup dialog (which
-    is retained in Windows and wxWidgets for backward compatibility).
-    On Windows 95 and NT 4.0 and above, the page setup dialog is native to the windowing
-    system, otherwise it is emulated.

 
 

-    The page setup dialog contains controls for paper size (A4, A5 etc.),
-    orientation (landscape or portrait), and controls for setting left, top, right
-    and bottom margin sizes in millimetres.
+    This class represents the page setup common dialog.

 
 

-    On Macintosh, the native page setup dialog is used, which lets you select paper
-    size and orientation but it does not let you change the page margins.
+    The page setup dialog contains controls for paper size (letter, A4, A5 etc.),
+    orientation (landscape or portrait), and, only under Windows currently,
+    controls for setting left, top, right and bottom margin sizes in millimetres.

 
 

-    On other platforms, a generic dialog is used.
+    The exact appearance of this dialog varies among the platforms as a native
+    dialog is used when available (currently the case for all major platforms).

 
     When the dialog has been closed, you need to query the wxPageSetupDialogData
     object associated with the dialog.
 
     When the dialog has been closed, you need to query the wxPageSetupDialogData
     object associated with the dialog.


@@ -95,10 +94,9 @@ public:
     @library{wxcore}
     @category{printing}
 
     @library{wxcore}
     @category{printing}
 

-    @see @ref overview_printing "Printing framework overview",
-         wxPrintDialog, wxPageSetupDialogData
+    @see @ref overview_printing, wxPrintDialog, wxPageSetupDialogData

 */
 */

-class wxPageSetupDialog : public wxDialog
+class wxPageSetupDialog : public wxObject

 {
 public:
     /**
 {
 public:
     /**


@@ -112,7 +110,7 @@ public:
     /**
         Destructor.
     */
     /**
         Destructor.
     */

-    ~wxPageSetupDialog();
+    virtual ~wxPageSetupDialog();

 
     /**
         Returns the wxPageSetupDialogData object associated with the dialog.
 
     /**
         Returns the wxPageSetupDialogData object associated with the dialog.