X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d62c1e628d2e36f00dd1c703a41c2d41415c10cc..4ee4c7b948e76377a6947d3ffbe5099870d0c3e9:/interface/wx/cmndata.h

diff --git a/interface/wx/cmndata.h b/interface/wx/cmndata.h
index b80af16af7..4f00278e74 100644
--- a/interface/wx/cmndata.h
+++ b/interface/wx/cmndata.h
@@ -12,7 +12,7 @@
     This class holds a variety of information related to font dialogs.
 
     @library{wxcore}
-    @category{cmndlg}
+    @category{cmndlg,data}
 
     @see @ref overview_cmndlg_font, wxFont, wxFontDialog
 */
@@ -54,7 +54,7 @@ public:
 
         The default value is black.
     */
-    wxColour& GetColour();
+    const wxColour& GetColour() const;
 
     /**
         Determines whether "effects" are enabled under Windows. This refers to
@@ -122,7 +122,7 @@ public:
     /**
         Assignment operator for the font data.
     */
-    void operator =(const wxFontData& data);
+    wxFontData& operator =(const wxFontData& data);
 };
 
 
@@ -137,7 +137,7 @@ public:
     stored by wxPageSetupDialogData).
 
     @library{wxcore}
-    @category{printing}
+    @category{printing,data}
 
     @see @ref overview_printing, wxPageSetupDialog
 */
@@ -152,12 +152,12 @@ public:
     /**
         Copy constructor.
     */
-    wxPageSetupDialogData(wxPageSetupDialogData& data);
+    wxPageSetupDialogData(const wxPageSetupDialogData& data);
 
     /**
         Construct an object from a print data object.
     */
-    wxPageSetupDialogData(wxPrintData& printData);
+    wxPageSetupDialogData(const wxPrintData& printData);
 
     /**
         Destructor.
@@ -265,7 +265,8 @@ public:
     /**
         Returns a reference to the print data associated with this object.
     */
-    wxPrintData GetPrintData();
+    wxPrintData& GetPrintData();
+    const wxPrintData& GetPrintData() const;
 
     /**
         Returns @true if the print data associated with the dialog data is
@@ -315,7 +316,7 @@ public:
 
         @see wxPrintData::SetPaperId()
     */
-    void SetPaperId(wxPaperSize& id);
+    void SetPaperId(wxPaperSize id);
 
     /**
         Sets the paper size in millimetres. If a corresponding paper id is
@@ -332,12 +333,12 @@ public:
     /**
         Assigns print data to this object.
     */
-    void operator =(const wxPrintData& data);
+    wxPageSetupDialogData& operator =(const wxPrintData& data);
 
     /**
         Assigns page setup data to this object.
     */
-    void operator =(const wxPageSetupDialogData& data);
+    wxPageSetupDialogData& operator =(const wxPageSetupDialogData& data);
 };
 
 
@@ -348,7 +349,7 @@ public:
     This class holds a variety of information related to colour dialogs.
 
     @library{wxcore}
-    @category{cmndlg}
+    @category{cmndlg,data}
 
     @see wxColour, wxColourDialog, @ref overview_cmndlg_colour
 */
@@ -402,7 +403,7 @@ public:
 
         The default value is @true.
     */
-    void SetChooseFull(const bool flag);
+    void SetChooseFull(bool flag);
 
     /**
         Sets the default colour for the colour dialog.
@@ -417,18 +418,27 @@ public:
         @param i
             An integer between 0 and 15 for whatever custom colour you want to
             set. The default custom colours are invalid colours.
+        @param colour
+            The colour to set
     */
     void SetCustomColour(int i, const wxColour& colour);
 
     /**
-        Assignment operator for the colour data.
+        Converts the colours saved in this class in a string form, separing
+        the various colours with a comma.
     */
-    void operator =(const wxColourData& data);
+    wxString ToString() const;
 
+    /**
+        Decodes the given string, which should be in the same format returned
+        by ToString(), and sets the internal colours.
+    */
+    bool FromString(const wxString& str);
 
-    /** @todo document these */
-    wxString wxColourData::ToString() const;
-    bool wxColourData::FromString(const wxString& str);
+    /**
+        Assignment operator for the colour data.
+    */
+    wxColourData& operator =(const wxColourData& data);
 };
 
 
@@ -501,7 +511,7 @@ enum wxPrintBin
     @endcode
 
     @library{wxcore}
-    @category{printing}
+    @category{printing,data}
 
     @see @ref overview_printing, wxPrintDialog, wxPageSetupDialog,
          wxPrintDialogData, wxPageSetupDialogData, @ref overview_cmndlg_print,
@@ -557,7 +567,7 @@ public:
     /**
         Gets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
     */
-    int GetOrientation() const;
+    wxPrintOrientation GetOrientation() const;
 
     /**
         Returns the paper size id.
@@ -570,7 +580,7 @@ public:
         Returns the printer name. If the printer name is the empty string, it
         indicates that the default printer should be used.
     */
-    const wxString GetPrinterName() const;
+    const wxString& GetPrinterName() const;
 
     /**
         Returns the current print quality. This can be a positive integer,
@@ -624,7 +634,7 @@ public:
     /**
         Sets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
     */
-    void SetOrientation(int orientation);
+    void SetOrientation(wxPrintOrientation orientation);
 
     /**
         Sets the paper id. This indicates the type of paper to be used. For a
@@ -658,7 +668,7 @@ public:
     /**
         Assigns print data to this object.
     */
-    void operator =(const wxPrintData& data);
+    wxPrintData& operator =(const wxPrintData& data);
 };
 
 
@@ -671,7 +681,7 @@ public:
     settings.
 
     @library{wxcore}
-    @category{printing}
+    @category{printing,cmndlg,data}
 
     @see @ref overview_printing, wxPrintDialog, @ref overview_cmndlg_print
 */
@@ -686,12 +696,12 @@ public:
     /**
         Copy constructor.
     */
-    wxPrintDialogData(wxPrintDialogData& dialogData);
+    wxPrintDialogData(const wxPrintDialogData& dialogData);
 
     /**
         Construct an object from a print dialog data object.
     */
-    wxPrintDialogData(wxPrintData& printData);
+    wxPrintDialogData(const wxPrintData& printData);
 
     /**
         Destructor.