/////////////////////////////////////////////////////////////////////////////
// Name: cmndata.h
-// Purpose: documentation for wxFontData class
+// Purpose: interface of wxFontData
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/**
@class wxFontData
@wxheader{cmndata.h}
-
+
@ref overview_wxfontdialogoverview "wxFontDialog overview"
-
+
This class holds a variety of information related to font dialogs.
-
+
@library{wxcore}
@category{FIXME}
-
- @seealso
- Overview, wxFont, wxFontDialog
+
+ @see Overview(), wxFont, wxFontDialog
*/
class wxFontData : public wxObject
{
Enables or disables 'effects' under MS Windows or generic only. This refers to
the
controls for manipulating colour, strikeout and underline properties.
-
The default value is @true.
*/
void EnableEffects(bool enable);
Under MS Windows, returns a flag determining whether symbol fonts can be
selected. Has no
effect on other platforms.
-
The default value is @true.
*/
bool GetAllowSymbols();
/**
Gets the colour associated with the font dialog.
-
The default value is black.
*/
wxColour GetColour();
/**
Determines whether 'effects' are enabled under Windows. This refers to the
controls for manipulating colour, strikeout and underline properties.
-
The default value is @true.
*/
bool GetEnableEffects();
/**
Returns @true if the Help button will be shown (Windows only).
-
The default value is @false.
*/
bool GetShowHelp();
/**
Under MS Windows, determines whether symbol fonts can be selected. Has no
effect on other platforms.
-
The default value is @true.
*/
void SetAllowSymbols(bool allowSymbols);
/**
Sets the colour that will be used for the font foreground colour.
-
The default colour is black.
*/
void SetColour(const wxColour& colour);
/**
Sets the valid range for the font point size (Windows only).
-
The default is 0, 0 (unrestricted range).
*/
void SetRange(int min, int max);
/**
Determines whether the Help button will be displayed in the font dialog
(Windows only).
-
The default value is @false.
*/
void SetShowHelp(bool showHelp);
};
+
/**
@class wxPageSetupDialogData
@wxheader{cmndata.h}
-
+
This class holds a variety of information related to wxPageSetupDialog.
-
+
It contains a wxPrintData member which is used to hold basic printer
configuration data (as opposed to the
user-interface configuration settings stored by wxPageSetupDialogData).
-
+
@library{wxcore}
@category{printing}
-
- @seealso
- @ref overview_printingoverview "Printing framework overview", wxPageSetupDialog
+
+ @see @ref overview_printingoverview "Printing framework overview",
+ wxPageSetupDialog
*/
class wxPageSetupDialogData : public wxObject
{
Construct an object from a print data object.
*/
wxPageSetupDialogData();
- wxPageSetupDialogData(wxPageSetupDialogData& data);
- wxPageSetupDialogData(wxPrintData& printData);
+ wxPageSetupDialogData(wxPageSetupDialogData& data);
+ wxPageSetupDialogData(wxPrintData& printData);
//@}
/**
as orientation)
instead of showing a dialog. Windows only.
*/
- bool GetDefaultInfo();
+ bool GetDefaultInfo() const;
/**
Returns @true if the page setup dialog will take its minimum margin values from
the currently
selected printer properties. Windows only.
*/
- bool GetDefaultMinMargins();
+ bool GetDefaultMinMargins() const;
/**
Returns @true if the printer setup button is enabled.
*/
- bool GetEnableHelp();
+ bool GetEnableHelp() const;
/**
Returns @true if the margin controls are enabled (Windows only).
*/
- bool GetEnableMargins();
+ bool GetEnableMargins() const;
/**
Returns @true if the orientation control is enabled (Windows only).
*/
- bool GetEnableOrientation();
+ bool GetEnableOrientation() const;
/**
Returns @true if the paper size control is enabled (Windows only).
*/
- bool GetEnablePaper();
+ bool GetEnablePaper() const;
/**
Returns @true if the printer setup button is enabled.
*/
- bool GetEnablePrinter();
+ bool GetEnablePrinter() const;
/**
Returns the right (x) and bottom (y) margins in millimetres.
*/
- wxPoint GetMarginBottomRight();
+ wxPoint GetMarginBottomRight() const;
/**
Returns the left (x) and top (y) margins in millimetres.
*/
- wxPoint GetMarginTopLeft();
+ wxPoint GetMarginTopLeft() const;
/**
Returns the right (x) and bottom (y) minimum margins the user can enter
(Windows only). Units
are in millimetres
*/
- wxPoint GetMinMarginBottomRight();
+ wxPoint GetMinMarginBottomRight() const;
/**
Returns the left (x) and top (y) minimum margins the user can enter (Windows
only). Units
are in millimetres
*/
- wxPoint GetMinMarginTopLeft();
+ wxPoint GetMinMarginTopLeft() const;
/**
Returns the paper id (stored in the internal wxPrintData object).
-
For further information, see wxPrintData::SetPaperId.
*/
- wxPaperSize GetPaperId();
+ wxPaperSize GetPaperId() const;
/**
Returns the paper size in millimetres.
*/
- wxSize GetPaperSize();
+ wxSize GetPaperSize() const;
/**
Returns a reference to the @ref overview_wxprintdata "print data" associated
This can return @false on Windows if the current printer is not set, for example.
On all other platforms, it returns @true.
*/
-#define bool IsOk() /* implementation is private */
+ bool IsOk() const;
/**
Pass @true if the dialog will simply return default printer information (such as
/**
Sets the paper size id. For further information, see wxPrintData::SetPaperId.
-
Calling this function overrides the explicit paper dimensions passed in
SetPaperSize().
*/
Assigns page setup data to this object.
*/
void operator =(const wxPrintData& data);
- void operator =(const wxPageSetupDialogData& data);
+ void operator =(const wxPageSetupDialogData& data);
//@}
};
+
/**
@class wxColourData
@wxheader{cmndata.h}
-
+
This class holds a variety of information related to colour dialogs.
-
+
@library{wxcore}
@category{FIXME}
-
- @seealso
- wxColour, wxColourDialog, @ref overview_wxcolourdialogoverview "wxColourDialog
- overview"
+
+ @see wxColour, wxColourDialog, @ref overview_wxcolourdialogoverview
+ "wxColourDialog overview"
*/
class wxColourData : public wxObject
{
dialog
will display full rgb colour picker or only available palette indexer.
Has no meaning under other platforms.
-
The default value is @true.
*/
- bool GetChooseFull();
+ bool GetChooseFull() const;
/**
Gets the current colour associated with the colour dialog.
-
The default colour is black.
*/
- wxColour GetColour();
+ wxColour GetColour() const;
/**
- Gets the @e ith custom colour associated with the colour dialog. @e i should
+ Gets the @e ith custom colour associated with the colour dialog. @a i should
be an integer between 0 and 15.
-
The default custom colours are invalid colours.
*/
- wxColour GetCustomColour(int i);
+ wxColour GetCustomColour(int i) const;
/**
Under Windows, tells the Windows colour dialog to display the full dialog
with custom colour selection controls. Under other platforms, has no effect.
-
The default value is @true.
*/
void SetChooseFull(const bool flag);
/**
Sets the default colour for the colour dialog.
-
The default colour is black.
*/
void SetColour(const wxColour& colour);
/**
- Sets the @e ith custom colour for the colour dialog. @e i should
+ Sets the @e ith custom colour for the colour dialog. @a i should
be an integer between 0 and 15.
-
The default custom colours are invalid colours.
*/
void SetCustomColour(int i, const wxColour& colour);
};
+
/**
@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 wxPostScriptDC. It is also used as a data member of wxPrintDialogData
and wxPageSetupDialogData, as part of the mechanism for transferring data
between the print dialogs and the application.
-
+
@library{wxcore}
@category{printing}
-
- @seealso
- @ref overview_printingoverview "Printing framework overview", wxPrintDialog,
- wxPageSetupDialog, wxPrintDialogData, wxPageSetupDialogData, @ref overview_wxprintdialogoverview "wxPrintDialog Overview", wxPrinterDC, wxPostScriptDC
+
+ @see @ref overview_printingoverview "Printing framework overview",
+ wxPrintDialog, wxPageSetupDialog, wxPrintDialogData, wxPageSetupDialogData, @ref overview_wxprintdialogoverview "wxPrintDialog Overview", wxPrinterDC, wxPostScriptDC
*/
class wxPrintData : public wxObject
{
Copy constructor.
*/
wxPrintData();
- wxPrintData(const wxPrintData& data);
+ wxPrintData(const wxPrintData& data);
//@}
/**
/**
Returns the current bin (papersource). By default, the system is left to select
the bin (@c wxPRINTBIN_DEFAULT is returned).
-
See SetBin() for the full list of bin values.
*/
- wxPrintBin GetBin();
+ wxPrintBin GetBin() const;
/**
Returns @true if collation is on.
*/
- bool GetCollate();
+ bool GetCollate() const;
/**
Returns @true if colour printing is on.
*/
- bool GetColour();
+ bool GetColour() const;
/**
Returns the duplex mode. One of wxDUPLEX_SIMPLEX, wxDUPLEX_HORIZONTAL,
wxDUPLEX_VERTICAL.
*/
- wxDuplexMode GetDuplex();
+ wxDuplexMode GetDuplex() const;
/**
Returns the number of copies requested by the user.
*/
- int GetNoCopies();
+ int GetNoCopies() const;
/**
Gets the orientation. This can be wxLANDSCAPE or wxPORTRAIT.
*/
- int GetOrientation();
+ int GetOrientation() const;
/**
Returns the paper size id. For more information, see SetPaperId().
*/
- wxPaperSize GetPaperId();
+ wxPaperSize GetPaperId() const;
/**
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 wxString GetPrinterName() const;
/**
Returns the current print quality. This can be a positive integer, denoting the
number of dots per inch, or
one of the following identifiers:
+
On input you should pass one of these identifiers, but on return you may get
back a positive integer
indicating the current resolution setting.
*/
- wxPrintQuality GetQuality();
+ wxPrintQuality GetQuality() const;
/**
Returns @true if the print data is valid for using in print dialogs.
This can return @false on Windows if the current printer is not set, for example.
On all other platforms, it returns @true.
*/
-#define bool IsOk() /* implementation is private */
+ bool IsOk() const;
/**
Sets the current bin. Possible values are:
between
paper id, paper size and string name, see wxPrintPaperDatabase in @c paper.h
(not yet documented).
-
- @e paperId can be one of:
+ @a paperId can be one of:
*/
void SetPaperId(wxPaperSize paperId);
Sets the desired print quality. This can be a positive integer, denoting the
number of dots per inch, or
one of the following identifiers:
+
On input you should pass one of these identifiers, but on return you may get
back a positive integer
indicating the current resolution setting.
but retained for backward compatibility.
*/
void operator =(const wxPrintData& data);
- void operator =(const wxPrintSetupData& data);
+ void operator =(const wxPrintSetupData& 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}
-
- @seealso
- @ref overview_printingoverview "Printing framework overview", wxPrintDialog,
- @ref overview_wxprintdialogoverview "wxPrintDialog Overview"
+
+ @see @ref overview_printingoverview "Printing framework overview",
+ wxPrintDialog, @ref overview_wxprintdialogoverview "wxPrintDialog Overview"
*/
class wxPrintDialogData : public wxObject
{
Construct an object from a print dialog data object.
*/
wxPrintDialogData();
- wxPrintDialogData(wxPrintDialogData& dialogData);
- wxPrintDialogData(wxPrintData& printData);
+ wxPrintDialogData(wxPrintDialogData& dialogData);
+ wxPrintDialogData(wxPrintData& printData);
//@}
/**
/**
Returns @true if the user requested that all pages be printed.
*/
- bool GetAllPages();
+ bool GetAllPages() const;
/**
Returns @true if the user requested that the document(s) be collated.
*/
- bool GetCollate();
+ bool GetCollate() const;
/**
Returns the @e from page number, as entered by the user.
*/
- int GetFromPage();
+ int GetFromPage() const;
/**
Returns the @e maximum page number.
*/
- int GetMaxPage();
+ int GetMaxPage() const;
/**
Returns the @e minimum page number.
*/
- int GetMinPage();
+ int GetMinPage() const;
/**
Returns the number of copies requested by the user.
*/
- int GetNoCopies();
+ int GetNoCopies() const;
/**
Returns a reference to the internal wxPrintData object.
/**
Returns @true if the user has selected printing to a file.
*/
- bool GetPrintToFile();
+ bool GetPrintToFile() const;
/**
Returns @true if the user requested that the selection be printed (where
'selection' is
a concept specific to the application).
*/
- bool GetSelection();
+ bool GetSelection() const;
/**
Returns the @e to page number, as entered by the user.
*/
- int GetToPage();
+ int GetToPage() const;
/**
Returns @true if the print data is valid for using in print dialogs.
This can return @false on Windows if the current printer is not set, for example.
On all other platforms, it returns @true.
*/
-#define bool IsOk() /* implementation is private */
+ bool IsOk() const;
/**
Sets the 'Collate' checkbox to @true or @false.
/**
Determines whether the dialog to be shown will be the Print dialog
(pass @false) or Print Setup dialog (pass @true).
-
This function has been deprecated since version 2.5.4.
*/
void SetSetupDialog(bool flag);
Assigns another print dialog data object to this object.
*/
void operator =(const wxPrintData& data);
- void operator =(const wxPrintDialogData& data);
+ void operator =(const wxPrintDialogData& data);
//@}
};
+
projects / wxWidgets.git / blobdiff