<wx/cmndata.h>
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
\wxheading{See also}
-\helpref{Overview}{wxfontdialogoverview}, \helpref{wxFontDialog}{wxfontdialog}
+\helpref{Overview}{wxfontdialogoverview}, \helpref{wxFont}{wxfont}, \helpref{wxFontDialog}{wxfontdialog}
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxFontData::wxFontData}
+\membersection{wxFontData::wxFontData}\label{wxfontdatactor}
\func{}{wxFontData}{\void}
Constructor. Initializes {\it fontColour} to black, {\it showHelp} to black,
-\rtfsp{\it allowSymbols} to TRUE, {\it enableEffects} to TRUE,
+\rtfsp{\it allowSymbols} to true, {\it enableEffects} to true,
\rtfsp{\it minSize} to 0 and {\it maxSize} to 0.
-\membersection{wxFontData::\destruct{wxFontData}}
-
-\func{}{\destruct{wxFontData}}{\void}
-
-Destructor.
-
-\membersection{wxFontData::EnableEffects}
+\membersection{wxFontData::EnableEffects}\label{wxfontdataenableeffects}
\func{void}{EnableEffects}{\param{bool}{ enable}}
-Enables or disables `effects' under MS Windows only. This refers to the
+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.
+The default value is true.
-\membersection{wxFontData::GetAllowSymbols}
+\membersection{wxFontData::GetAllowSymbols}\label{wxfontdatagetallowsymbols}
\func{bool}{GetAllowSymbols}{\void}
Under MS Windows, returns a flag determining whether symbol fonts can be selected. Has no
effect on other platforms.
-The default value is TRUE.
+The default value is true.
-\membersection{wxFontData::GetColour}
+\membersection{wxFontData::GetColour}\label{wxfontdatagetcolour}
\func{wxColour\&}{GetColour}{\void}
The default value is black.
-\membersection{wxFontData::GetChosenFont}
+\membersection{wxFontData::GetChosenFont}\label{wxfontdatagetchosenfont}
\func{wxFont}{GetChosenFont}{\void}
-Gets the font chosen by the user. If the user pressed OK (wxFontDialog::Show returned TRUE), this returns
-a new font which is now `owned' by the application, and should be deleted
-if not required. If the user pressed Cancel (wxFontDialog::Show returned FALSE) or
-the colour dialog has not been invoked yet, this will return NULL.
+Gets the font chosen by the user if the user pressed OK (wxFontDialog::ShowModal returned wxID\_OK).
-\membersection{wxFontData::GetEnableEffects}
+\membersection{wxFontData::GetEnableEffects}\label{wxfontdatagetenableeffects}
\func{bool}{GetEnableEffects}{\void}
Determines whether `effects' are enabled under Windows. This refers to the
controls for manipulating colour, strikeout and underline properties.
-The default value is TRUE.
+The default value is true.
-\membersection{wxFontData::GetInitialFont}
+\membersection{wxFontData::GetInitialFont}\label{wxfontdatagetinitialfont}
\func{wxFont}{GetInitialFont}{\void}
Gets the font that will be initially used by the font dialog. This should have
previously been set by the application.
-\membersection{wxFontData::GetShowHelp}
+\membersection{wxFontData::GetShowHelp}\label{wxfontdatagetshowhelp}
\func{bool}{GetShowHelp}{\void}
-Returns TRUE if the Help button will be shown (Windows only).
+Returns true if the Help button will be shown (Windows only).
-The default value is FALSE.
+The default value is false.
-\membersection{wxFontData::SetAllowSymbols}
+\membersection{wxFontData::SetAllowSymbols}\label{wxfontdatasetallowsymbols}
\func{void}{SetAllowSymbols}{\param{bool}{ allowSymbols}}
Under MS Windows, determines whether symbol fonts can be selected. Has no
effect on other platforms.
-The default value is TRUE.
+The default value is true.
-\membersection{wxFontData::SetChosenFont}
+\membersection{wxFontData::SetChosenFont}\label{wxfontdatasetchosenfont}
\func{void}{SetChosenFont}{\param{const wxFont\& }{font}}
Sets the font that will be returned to the user (for internal use only).
-\membersection{wxFontData::SetColour}
+\membersection{wxFontData::SetColour}\label{wxfontdatasetcolour}
\func{void}{SetColour}{\param{const wxColour\&}{ colour}}
The default colour is black.
-\membersection{wxFontData::SetInitialFont}
+\membersection{wxFontData::SetInitialFont}\label{wxfontdatasetinitialfont}
\func{void}{SetInitialFont}{\param{const wxFont\&}{font}}
Sets the font that will be initially used by the font dialog.
-\membersection{wxFontData::SetRange}
+\membersection{wxFontData::SetRange}\label{wxfontdatasetrange}
\func{void}{SetRange}{\param{int}{ min}, \param{int}{ max}}
The default is 0, 0 (unrestricted range).
-\membersection{wxFontData::SetShowHelp}
+\membersection{wxFontData::SetShowHelp}\label{wxfontdatasetshowhelp}
\func{void}{SetShowHelp}{\param{bool}{ showHelp}}
Determines whether the Help button will be displayed in the font dialog (Windows only).
-The default value is FALSE.
+The default value is false.
-\membersection{wxFontData::operator $=$}
+\membersection{wxFontData::operator $=$}\label{wxfontdataassign}
\func{void}{operator $=$}{\param{const wxFontData\&}{ data}}
-Assingment operator for the font data.
+Assignment operator for the font data.
\section{\class{wxFontDialog}}\label{wxfontdialog}
<wx/fontdlg.h>
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
\wxheading{See also}
\helpref{Overview}{wxfontdialogoverview},\\
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxFontDialog::wxFontDialog}
+\membersection{wxFontDialog::wxFontDialog}\label{wxfontdialogctor}
+
+\func{}{wxFontDialog}{\void}
+
+\func{}{wxFontDialog}{\param{wxWindow* }{parent}}
+
+\func{}{wxFontDialog}{\param{wxWindow* }{parent}, \param{const wxFontData\& }{data}}
+
+Constructor. Pass a parent window, and optionally the
+\helpref{font data}{wxfontdata} object to be used to initialize the dialog
+controls. If the default constructor is used,
+\helpref{Create()}{wxfontdialogcreate} must be called before the dialog can be
+shown.
-\func{}{wxFontDialog}{\param{wxWindow* }{parent}, \param{wxFontData* }{data = NULL}}
+\membersection{wxFontDialog::Create}\label{wxfontdialogcreate}
-Constructor. Pass a parent window, and optionally a pointer to a block of font
-data, which will be copied to the font dialog's font data.
+\func{bool}{Create}{\param{wxWindow* }{parent}}
-\membersection{wxFontDialog::\destruct{wxFontDialog}}
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxFontData\& }{data}}
-\func{}{\destruct{wxFontDialog}}{\void}
+Creates the dialog if it the wxFontDialog object had been initialized using the
+default constructor. Returns \true on success and \false if an error
+occurred.
-Destructor.
+\membersection{wxFontDialog::GetFontData}\label{wxfontdialoggetfontdata}
-\membersection{wxFontDialog::GetFontData}
+\constfunc{const wxFontData\&}{GetFontData}{\void}
\func{wxFontData\&}{GetFontData}{\void}
Returns the \helpref{font data}{wxfontdata} associated with the font dialog.
-\membersection{wxFontDialog::ShowModal}
+\membersection{wxFontDialog::ShowModal}\label{wxfontdialogshowmodal}
\func{int}{ShowModal}{\void}
-Shows the dialog, returning wxID\_OK if the user pressed Ok, and wxID\_CANCEL
-otherwise.
+Shows the dialog, returning {\tt wxID\_OK} if the user pressed Ok, and
+{\tt wxID\_CANCEL} otherwise.
-If the user cancels the dialog (ShowModal returns wxID\_CANCEL), no font will be
-created. If the user presses OK (ShowModal returns wxID\_OK), a new wxFont will
-be created and stored in the font dialog's wxFontData structure.
+If the user cancels the dialog (ShowModal returns {\tt wxID\_CANCEL}), no font
+will be created. If the user presses OK, a new wxFont will be created and
+stored in the font dialog's wxFontData structure.
projects / wxWidgets.git / blobdiff