X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4707b84cd074ff2ae9ada99579f864eb300f8774..0c3e2a5baacbb9f9a43f0887521061c9aa0239d4:/interface/wx/cmndata.h diff --git a/interface/wx/cmndata.h b/interface/wx/cmndata.h index 72b00a26d6..ab0492c72d 100644 --- a/interface/wx/cmndata.h +++ b/interface/wx/cmndata.h @@ -3,7 +3,7 @@ // Purpose: interface of common wx*Data classes (font, colour, print) // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -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 */ @@ -137,7 +137,7 @@ public: stored by wxPageSetupDialogData). @library{wxcore} - @category{printing} + @category{printing,data} @see @ref overview_printing, wxPageSetupDialog */ @@ -349,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 */ @@ -418,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. */ - wxColourData& 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); }; @@ -502,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, @@ -558,7 +567,7 @@ public: /** Gets the orientation. This can be wxLANDSCAPE or wxPORTRAIT. */ - int GetOrientation() const; + wxPrintOrientation GetOrientation() const; /** Returns the paper size id. @@ -625,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 @@ -659,7 +668,7 @@ public: /** Assigns print data to this object. */ - void operator =(const wxPrintData& data); + wxPrintData& operator =(const wxPrintData& data); }; @@ -672,7 +681,7 @@ public: settings. @library{wxcore} - @category{printing} + @category{printing,cmndlg,data} @see @ref overview_printing, wxPrintDialog, @ref overview_cmndlg_print */