fixing file paths after renaming

[wxWidgets.git] / interface / printdlg.h

diff --git a/interface/printdlg.h b/interface/printdlg.h
index 3fcade0c1d6aa26ec928948b66df6c77ab6a1298..4a174546bbd37beff288f9e825fefa0239f72fb1 100644 (file)
--- a/interface/printdlg.h
+++ b/interface/printdlg.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        printdlg.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        printdlg.h

-// Purpose:     documentation for wxPrintDialog class
+// Purpose:     interface of wxPrintDialog

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,37 +9,40 @@
 /**
     @class wxPrintDialog
     @wxheader{printdlg.h}
 /**
     @class wxPrintDialog
     @wxheader{printdlg.h}

-    
+

     This class represents the print and print setup common dialogs.
     This class represents the print and print setup common dialogs.

-    You may obtain a wxPrinterDC device context from
-    a successfully dismissed print dialog.
-    
+    You may obtain a wxPrinterDC device context from a successfully dismissed
+    print dialog.
+

     @library{wxcore}
     @category{printing}
     @library{wxcore}
     @category{printing}

-    
-    @seealso
-    @ref overview_printingoverview "Printing framework overview", @ref
-    overview_wxprintdialogoverview "wxPrintDialog Overview"
+
+    @see @ref overview_printing, @ref overview_cmndlg_print

 */
 class wxPrintDialog : public wxDialog
 {
 public:
     /**
 */
 class wxPrintDialog : public wxDialog
 {
 public:
     /**

-        Constructor. Pass a parent window, and optionally a pointer to a block of print
+        Constructor.
+
+        Pass a parent window, and optionally a pointer to a block of print

         data, which will be copied to the print dialog's print data.
         data, which will be copied to the print dialog's print data.

-        
-        @sa wxPrintDialogData
+
+        @see wxPrintDialogData

     */
     */

-    wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = @NULL);
+    wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);

 
     /**
 
     /**

-        Destructor. If GetPrintDC() has @e not been called,
-        the device context obtained by the dialog (if any) will be deleted.
+        Destructor.
+
+        If GetPrintDC() has not been called, the device context obtained by
+        the dialog (if any) will be deleted.

     */
     ~wxPrintDialog();
 
     /**
         Returns the device context created by the print dialog, if any.
     */
     ~wxPrintDialog();
 
     /**
         Returns the device context created by the print dialog, if any.

+

         When this function has been called, the ownership of the device context
         is transferred to the application, so it must then be deleted
         explicitly.
         When this function has been called, the ownership of the device context
         is transferred to the application, so it must then be deleted
         explicitly.


@@ -47,63 +50,64 @@ public:
     wxDC* GetPrintDC();
 
     /**
     wxDC* GetPrintDC();
 
     /**

-        Returns the @ref overview_wxprintdialogdata "print dialog data" associated with
-        the print dialog.
+        Returns the @ref overview_printing_printdata "print dialog data" associated
+        with the print dialog.

     */
     wxPrintDialogData GetPrintDialogData();
 
     /**
     */
     wxPrintDialogData GetPrintDialogData();
 
     /**

-        Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
-        otherwise. After this function is called, a device context may
-        be retrievable using GetPrintDC().
+        Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c
+        wxID_CANCEL otherwise.
+
+        After this function is called, a device context may be retrievable using
+        GetPrintDC().

     */
     int ShowModal();
 };
 
 
     */
     int ShowModal();
 };
 
 

+

 /**
     @class wxPageSetupDialog
     @wxheader{printdlg.h}
 /**
     @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
     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.
-    
+    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.
     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.

-    
+

     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.
     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.

-    
+

     On other platforms, a generic dialog is used.
     On other platforms, a generic dialog is used.

-    
-    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.
+

     Note that the OK and Cancel buttons do not destroy the dialog; this must be done
     by the application.
     Note that the OK and Cancel buttons do not destroy the dialog; this must be done
     by the application.

-    
+

     @library{wxcore}
     @category{printing}
     @library{wxcore}
     @category{printing}

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

 */
 class wxPageSetupDialog : public wxDialog
 {
 public:
     /**
 */
 class wxPageSetupDialog : public wxDialog
 {
 public:
     /**

-        Constructor. Pass a parent window, and optionally a pointer to a block of page
-        setup
-        data, which will be copied to the print dialog's internal data.
+        Constructor.
+
+        Pass a parent window, and optionally a pointer to a block of page
+        setup data, which will be copied to the print dialog's internal data.

     */
     */

-    wxPageSetupDialog(wxWindow* parent,
-                      wxPageSetupDialogData* data = @NULL);
+    wxPageSetupDialog(wxWindow* parent, wxPageSetupDialogData* data = NULL);

 
     /**
         Destructor.
 
     /**
         Destructor.


@@ -111,14 +115,14 @@ public:
     ~wxPageSetupDialog();
 
     /**
     ~wxPageSetupDialog();
 
     /**

-        Returns the @ref overview_wxpagesetupdialogdata "page setup data" associated
-        with the dialog.
+        Returns the wxPageSetupDialogData object associated with the dialog.

     */
     */

-    wxPageSetupDialogData GetPageSetupData();
+    wxPageSetupDialogData& GetPageSetupData();

 
     /**
 
     /**

-        Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
-        otherwise.
+        Shows the dialog, returning @c wxID_OK if the user pressed OK, and
+        @c wxID_CANCEL otherwise.

     */
     int ShowModal();
 };
     */
     int ShowModal();
 };

+