documentation for window ids allocation and wxIdManager (patch 1870570)

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

diff --git a/docs/latex/wx/fontdlg.tex b/docs/latex/wx/fontdlg.tex
index 0c77c38639edb7885ad300608e67a7ca50b56840..2dd8be45c1c58b8c809dad8cb550d5cf21beb7a9 100644 (file)
--- a/docs/latex/wx/fontdlg.tex
+++ b/docs/latex/wx/fontdlg.tex
@@ -12,45 +12,43 @@ This class holds a variety of information related to font dialogs.
 
 <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}
 
@@ -58,55 +56,52 @@ Gets the colour associated with the font dialog.
 
 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}}
 
@@ -114,13 +109,13 @@ Sets the colour that will be used for the font foreground 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}}
 
@@ -128,19 +123,19 @@ Sets the valid range for the font point size (Windows only).
 
 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}
 
@@ -149,6 +144,7 @@ This class represents the font chooser dialog.
 \wxheading{Derived from}
 
 \helpref{wxDialog}{wxdialog}\\
+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
@@ -157,6 +153,10 @@ This class represents the font chooser dialog.
 
 <wx/fontdlg.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{Overview}{wxfontdialogoverview},\\
@@ -165,7 +165,7 @@ This class represents the font chooser dialog.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxFontDialog::wxFontDialog}
+\membersection{wxFontDialog::wxFontDialog}\label{wxfontdialogctor}
 
 \func{}{wxFontDialog}{\void}
 
@@ -181,23 +181,15 @@ shown.
 
 \membersection{wxFontDialog::Create}\label{wxfontdialogcreate}
 
-\func{bool}{Create}{\void}
-
 \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 {\tt TRUE} on success and {\tt FALSE} if an error
-occured.
-
-\membersection{wxFontDialog::\destruct{wxFontDialog}}
-
-\func{}{\destruct{wxFontDialog}}{\void}
-
-Destructor.
+default constructor. Returns \true on success and \false if an error
+occurred.
 
-\membersection{wxFontDialog::GetFontData}
+\membersection{wxFontDialog::GetFontData}\label{wxfontdialoggetfontdata}
 
 \constfunc{const wxFontData\&}{GetFontData}{\void}
 
@@ -205,7 +197,7 @@ Destructor.
 
 Returns the \helpref{font data}{wxfontdata} associated with the font dialog.
 
-\membersection{wxFontDialog::ShowModal}
+\membersection{wxFontDialog::ShowModal}\label{wxfontdialogshowmodal}
 
 \func{int}{ShowModal}{\void}