// Purpose: interface of common wx*Data classes (font, colour, print)
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
/**
@class wxFontData
- @wxheader{cmndata.h}
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
*/
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
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
/**
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.
stored by wxPageSetupDialogData).
@library{wxcore}
- @category{printing}
+ @category{printing,data}
@see @ref overview_printing, wxPageSetupDialog
*/
/**
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).
/**
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
@see wxPrintData::SetPaperId()
*/
- void SetPaperId(wxPaperSize& id);
+ void SetPaperId(wxPaperSize id);
/**
Sets the paper size in millimetres. If a corresponding paper id is
/**
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.
@library{wxcore}
- @category{cmndlg}
+ @category{cmndlg,data}
@see wxColour, wxColourDialog, @ref overview_cmndlg_colour
*/
/**
Destructor.
*/
- ~wxColourData();
+ virtual ~wxColourData();
/**
Under Windows, determines whether the Windows colour dialog will
The default colour is black.
*/
- wxColour& GetColour() const;
+ wxColour& GetColour();
/**
Returns custom colours associated with the colour dialog.
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
The default value is @true.
*/
- void SetChooseFull(const bool flag);
+ void SetChooseFull(bool flag);
/**
Sets the default colour for the colour dialog.
@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);
+ /**
+ Converts the colours saved in this class in a string form, separing
+ the various colours with a comma.
+ */
+ 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);
+
/**
Assignment operator for the colour data.
*/
- void operator =(const wxColourData& data);
+ wxColourData& operator =(const wxColourData& data);
};
/**
@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
between the print dialogs and the application.
@remarks
-
+
The following functions are specific to PostScript printing and have not
yet been documented:
@endcode
@library{wxcore}
- @category{printing}
+ @category{printing,data}
@see @ref overview_printing, wxPrintDialog, wxPageSetupDialog,
wxPrintDialogData, wxPageSetupDialogData, @ref overview_cmndlg_print,
/**
Destructor.
*/
- ~wxPrintData();
+ virtual ~wxPrintData();
/**
Returns the current bin (papersource). By default, the system is left
/**
Gets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
*/
- int GetOrientation() const;
+ wxPrintOrientation GetOrientation() const;
/**
Returns the paper size id.
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,
/**
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
/**
Assigns print data to this object.
*/
- void operator =(const wxPrintData& data);
+ wxPrintData& operator =(const wxPrintData& data);
};
/**
@class wxPrintDialogData
- @wxheader{cmndata.h}
This class holds information related to the visual characteristics of
wxPrintDialog. It contains a wxPrintData object with underlying printing
settings.
@library{wxcore}
- @category{printing}
+ @category{printing,cmndlg,data}
@see @ref overview_printing, wxPrintDialog, @ref overview_cmndlg_print
*/
/**
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.
Determines whether the dialog to be shown will be the Print dialog
(pass @false) or Print Setup dialog (pass @true).
-
+
*/
void SetSetupDialog(bool flag);
projects / wxWidgets.git / blobdiff