replaced deprecated wxMULTIPLE with wxFD_MULTIPLE

[wxWidgets.git] / docs / latex / wx / fontdlg.tex

\section{\class{wxFontData}}\label{wxfontdata}

\overview{wxFontDialog overview}{wxfontdialogoverview}

This class holds a variety of information related to font dialogs.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/cmndata.h>

\wxheading{See also}

\helpref{Overview}{wxfontdialogoverview}, \helpref{wxFont}{wxfont}, \helpref{wxFontDialog}{wxfontdialog}

\latexignore{\rtfignore{\wxheading{Members}}}

\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 minSize} to 0 and {\it maxSize} to 0.

\membersection{wxFontData::EnableEffects}\label{wxfontdataenableeffects}

\func{void}{EnableEffects}{\param{bool}{ enable}}

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.

\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.

\membersection{wxFontData::GetColour}\label{wxfontdatagetcolour}

\func{wxColour\&}{GetColour}{\void}

Gets the colour associated with the font dialog.

The default value is black.

\membersection{wxFontData::GetChosenFont}\label{wxfontdatagetchosenfont}

\func{wxFont}{GetChosenFont}{\void}

Gets the font chosen by the user if the user pressed OK (wxFontDialog::ShowModal returned wxID\_OK).

\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.

\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}\label{wxfontdatagetshowhelp}

\func{bool}{GetShowHelp}{\void}

Returns true if the Help button will be shown (Windows only).

The default value is false.

\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.

\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}\label{wxfontdatasetcolour}

\func{void}{SetColour}{\param{const wxColour\&}{ colour}}

Sets the colour that will be used for the font foreground colour.

The default colour is black.

\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}\label{wxfontdatasetrange}

\func{void}{SetRange}{\param{int}{ min}, \param{int}{ max}}

Sets the valid range for the font point size (Windows only).

The default is 0, 0 (unrestricted range).

\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.

\membersection{wxFontData::operator $=$}\label{wxfontdataassign}

\func{void}{operator $=$}{\param{const wxFontData\&}{ data}}

Assignment operator for the font data.

\section{\class{wxFontDialog}}\label{wxfontdialog}

This class represents the font chooser dialog.

\wxheading{Derived from}

\helpref{wxDialog}{wxdialog}\\
\helpref{wxWindow}{wxwindow}\\
\helpref{wxEvtHandler}{wxevthandler}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/fontdlg.h>

\wxheading{See also}

\helpref{Overview}{wxfontdialogoverview},\\
\helpref{wxFontData}{wxfontdata},\\
\helpref{wxGetFontFromUser}{wxgetfontfromuser}

\latexignore{\rtfignore{\wxheading{Members}}}

\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.

\membersection{wxFontDialog::Create}\label{wxfontdialogcreate}

\func{bool}{Create}{\param{wxWindow* }{parent}}

\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxFontData\& }{data}}

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.

\membersection{wxFontDialog::GetFontData}\label{wxfontdialoggetfontdata}

\constfunc{const wxFontData\&}{GetFontData}{\void}

\func{wxFontData\&}{GetFontData}{\void}

Returns the \helpref{font data}{wxfontdata} associated with the font dialog.

\membersection{wxFontDialog::ShowModal}\label{wxfontdialogshowmodal}

\func{int}{ShowModal}{\void}

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 {\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.