added a way to create fonts with specified pixel size

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

diff --git a/docs/latex/wx/fontdlg.tex b/docs/latex/wx/fontdlg.tex
index dc3a0549e621aa2e570ba53495c80d7df34927f8..cfb372c9c2e583071ef06413226458b6566bcfac 100644 (file)
--- a/docs/latex/wx/fontdlg.tex
+++ b/docs/latex/wx/fontdlg.tex
@@ -23,7 +23,7 @@ This class holds a variety of information related to font dialogs.
 \func{}{wxFontData}{\void}
 
 Constructor. Initializes {\it fontColour} to black, {\it showHelp} to black,
 \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}}
 \rtfsp{\it minSize} to 0 and {\it maxSize} to 0.
 
 \membersection{wxFontData::\destruct{wxFontData}}


@@ -39,7 +39,7 @@ Destructor.
 Enables or disables `effects' under MS Windows only. This refers to the
 controls for manipulating colour, strikeout and underline properties.
 
 Enables or disables `effects' under MS Windows 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}
 


@@ -48,7 +48,7 @@ The default value is TRUE.
 Under MS Windows, returns a flag determining whether symbol fonts can be selected. Has no
 effect on other platforms.
 
 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}
 


@@ -62,10 +62,7 @@ The default value is black.
 
 \func{wxFont}{GetChosenFont}{\void}
 
 
 \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}
 


@@ -74,7 +71,7 @@ the colour dialog has not been invoked yet, this will return NULL.
 Determines whether `effects' are enabled under Windows. This refers to the
 controls for manipulating colour, strikeout and underline properties.
 
 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}
 


@@ -87,9 +84,9 @@ previously been set by the application.
 
 \func{bool}{GetShowHelp}{\void}
 
 
 \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}
 


@@ -98,7 +95,7 @@ The default value is FALSE.
 Under MS Windows, determines whether symbol fonts can be selected. Has no
 effect on other platforms.
 
 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}
 


@@ -134,13 +131,13 @@ The default is 0, 0 (unrestricted range).
 
 Determines whether the Help button will be displayed in the font dialog (Windows only).
 
 
 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 $=$}
 
 \func{void}{operator $=$}{\param{const wxFontData\&}{ data}}
 
 
 \membersection{wxFontData::operator $=$}
 
 \func{void}{operator $=$}{\param{const wxFontData\&}{ data}}
 

-Assingment operator for the font data.
+Assignment operator for the font data.

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


@@ -159,16 +156,37 @@ This class represents the font chooser dialog.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

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

 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxFontDialog::wxFontDialog}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxFontDialog::wxFontDialog}
 

-\func{}{wxFontDialog}{\param{wxWindow* }{parent}, \param{wxFontData* }{data = NULL}}
+\func{}{wxFontDialog}{\void}

 
 

-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{}{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}{\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}}
 
 
 \membersection{wxFontDialog::\destruct{wxFontDialog}}
 


@@ -178,6 +196,8 @@ Destructor.
 
 \membersection{wxFontDialog::GetFontData}
 
 
 \membersection{wxFontDialog::GetFontData}
 

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

 \func{wxFontData\&}{GetFontData}{\void}
 
 Returns the \helpref{font data}{wxfontdata} associated with the font dialog.
 \func{wxFontData\&}{GetFontData}{\void}
 
 Returns the \helpref{font data}{wxfontdata} associated with the font dialog.


@@ -186,10 +206,10 @@ Returns the \helpref{font data}{wxfontdata} associated with the font dialog.
 
 \func{int}{ShowModal}{\void}
 
 
 \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.