Doc and comment cleanup, fixes, tweaks

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

diff --git a/interface/wx/cmndata.h b/interface/wx/cmndata.h
index 70c26781d19fdb1945982cfe1dfadb6b0f3f7db3..72b00a26d616248193b4a7ddd964d16c4796eeda 100644 (file)
--- a/interface/wx/cmndata.h
+++ b/interface/wx/cmndata.h
@@ -8,7 +8,6 @@
 
 /**
     @class wxFontData
-    @wxheader{cmndata.h}
 
     This class holds a variety of information related to font dialogs.
 
@@ -42,20 +41,20 @@ public:
 
         The default value is @true.
     */
-    bool GetAllowSymbols();
+    bool GetAllowSymbols() const;
 
     /**
         Gets the font chosen by the user if the user pressed OK
         (wxFontDialog::ShowModal() returned wxID_OK).
     */
-    wxFont GetChosenFont();
+    wxFont GetChosenFont() const;
 
     /**
         Gets the colour associated with the font dialog.
 
         The default value is black.
     */
-    wxColour& GetColour();
+    const wxColour& GetColour() const;
 
     /**
         Determines whether "effects" are enabled under Windows. This refers to
@@ -64,20 +63,20 @@ public:
 
         The default value is @true.
     */
-    bool GetEnableEffects();
+    bool GetEnableEffects() const;
 
     /**
         Gets the font that will be initially used by the font dialog. This
         should have previously been set by the application.
     */
-    wxFont GetInitialFont();
+    wxFont GetInitialFont() const;
 
     /**
         Returns @true if the Help button will be shown (Windows only).
 
         The default value is @false.
     */
-    bool GetShowHelp();
+    bool GetShowHelp() const;
 
     /**
         Under Windows, determines whether symbol fonts can be selected. Has no
@@ -123,14 +122,13 @@ public:
     /**
         Assignment operator for the font data.
     */
-    void operator =(const wxFontData& data);
+    wxFontData& operator =(const wxFontData& data);
 };
 
 
 
 /**
     @class wxPageSetupDialogData
-    @wxheader{cmndata.h}
 
     This class holds a variety of information related to wxPageSetupDialog.
 
@@ -154,17 +152,17 @@ 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.
     */
-    ~wxPageSetupDialogData();
+    virtual ~wxPageSetupDialogData();
 
     /**
         Enables or disables the "Help" button (Windows only).
@@ -267,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
@@ -317,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
@@ -334,19 +333,18 @@ 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);
 };
 
 
 
 /**
     @class wxColourData
-    @wxheader{cmndata.h}
 
     This class holds a variety of information related to colour dialogs.
 
@@ -368,7 +366,7 @@ public:
     /**
         Destructor.
     */
-    ~wxColourData();
+    virtual ~wxColourData();
 
     /**
         Under Windows, determines whether the Windows colour dialog will
@@ -386,7 +384,7 @@ public:
 
         The default colour is black.
     */
-    wxColour& GetColour() const;
+    wxColour& GetColour();
 
     /**
         Returns custom colours associated with the colour dialog.
@@ -396,7 +394,7 @@ public:
             that the user has saved. The default custom colours are invalid
             colours.
     */
-    wxColour& GetCustomColour(int i) const;
+    wxColour GetCustomColour(int i) const;
 
     /**
         Under Windows, tells the Windows colour dialog to display the full
@@ -405,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.
@@ -426,7 +424,12 @@ public:
     /**
         Assignment operator for the colour data.
     */
-    void operator =(const wxColourData& data);
+    wxColourData& operator =(const wxColourData& data);
+
+
+    /** @todo document these */
+    wxString wxColourData::ToString() const;
+    bool wxColourData::FromString(const wxString& str);
 };
 
 
@@ -459,7 +462,6 @@ enum wxPrintBin
 
 /**
     @class wxPrintData
-    @wxheader{cmndata.h}
 
     This class holds a variety of information related to printers and printer
     device contexts. This class is used to create a wxPrinterDC and a
@@ -468,7 +470,7 @@ enum wxPrintBin
     between the print dialogs and the application.
 
     @remarks
-    
+
     The following functions are specific to PostScript printing and have not
     yet been documented:
 
@@ -522,7 +524,7 @@ public:
     /**
         Destructor.
     */
-    ~wxPrintData();
+    virtual ~wxPrintData();
 
     /**
         Returns the current bin (papersource). By default, the system is left
@@ -569,7 +571,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,
@@ -664,7 +666,6 @@ public:
 
 /**
     @class wxPrintDialogData
-    @wxheader{cmndata.h}
 
     This class holds information related to the visual characteristics of
     wxPrintDialog. It contains a wxPrintData object with underlying printing
@@ -686,17 +687,17 @@ 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.
     */
-    ~wxPrintDialogData();
+    virtual ~wxPrintDialogData();
 
     /**
         Enables or disables the "Help" button.
@@ -824,7 +825,7 @@ public:
 
         Determines whether the dialog to be shown will be the Print dialog
         (pass @false) or Print Setup dialog (pass @true).
-        
+
     */
     void SetSetupDialog(bool flag);