Added ability to execute more code after the widget is created

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

diff --git a/docs/latex/wx/font.tex b/docs/latex/wx/font.tex
index 1c3682a2f500dc7d560b211acab1b0e55c7fb586..db5d0a0d6792ed7c39c606a52a50bf7c97474b97 100644 (file)
--- a/docs/latex/wx/font.tex
+++ b/docs/latex/wx/font.tex
@@ -4,6 +4,10 @@ A font is an object which determines the appearance of text. Fonts are
 used for drawing text to a device context, and setting the appearance of
 a window's text.
 
 used for drawing text to a device context, and setting the appearance of
 a window's text.
 

+You can retrieve the current system font settings with \helpref{wxSystemSettings}{wxsystemsettings}.
+
+\helpref{wxSystemSettings}{wxsystemsettings}
+

 \wxheading{Derived from}
 
 \helpref{wxGDIObject}{wxgdiobject}\\
 \wxheading{Derived from}
 
 \helpref{wxGDIObject}{wxgdiobject}\\


@@ -15,6 +19,34 @@ a window's text.
 
 \wxheading{Constants}
 
 
 \wxheading{Constants}
 

+The font flags which can be used during the font creation are:
+
+\begin{verbatim}
+enum
+{
+    // no special flags: font with default weight/slant/anti-aliasing
+    wxFONTFLAG_DEFAULT          = 0,
+
+    // slant flags (default: no slant)
+    wxFONTFLAG_ITALIC           = 1 << 0,
+    wxFONTFLAG_SLANT            = 1 << 1,
+
+    // weight flags (default: medium)
+    wxFONTFLAG_LIGHT            = 1 << 2,
+    wxFONTFLAG_BOLD             = 1 << 3,
+
+    // anti-aliasing flag: force on or off (default: the current system default)
+    wxFONTFLAG_ANTIALIASED      = 1 << 4,
+    wxFONTFLAG_NOT_ANTIALIASED  = 1 << 5,
+
+    // underlined/strikethrough flags (default: no lines)
+    wxFONTFLAG_UNDERLINED       = 1 << 6,
+    wxFONTFLAG_STRIKETHROUGH    = 1 << 7,
+};
+\end{verbatim}
+
+The known font encodings are:
+

 \begin{verbatim}
 enum wxFontEncoding
 {
 \begin{verbatim}
 enum wxFontEncoding
 {


@@ -92,7 +124,7 @@ wxSWISS\_FONT}
 
 \helpref{wxFont overview}{wxfontoverview}, \helpref{wxDC::SetFont}{wxdcsetfont},\rtfsp
 \helpref{wxDC::DrawText}{wxdcdrawtext}, \helpref{wxDC::GetTextExtent}{wxdcgettextextent},\rtfsp
 
 \helpref{wxFont overview}{wxfontoverview}, \helpref{wxDC::SetFont}{wxdcsetfont},\rtfsp
 \helpref{wxDC::DrawText}{wxdcdrawtext}, \helpref{wxDC::GetTextExtent}{wxdcgettextextent},\rtfsp

-\helpref{wxFontDialog}{wxfontdialog}
+\helpref{wxFontDialog}{wxfontdialog}, \helpref{wxSystemSettings}{wxsystemsettings}

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


@@ -103,7 +135,7 @@ wxSWISS\_FONT}
 Default constructor.
 
 \func{}{wxFont}{\param{int}{ pointSize}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight},
 Default constructor.
 
 \func{}{wxFont}{\param{int}{ pointSize}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight},

- \param{const bool}{ underline = FALSE}, \param{const wxString\& }{faceName = ""},
+ \param{const bool}{ underline = false}, \param{const wxString\& }{faceName = ""},

  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 
 Creates a font object (see \helpref{font encoding
  \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}}
 
 Creates a font object (see \helpref{font encoding


@@ -129,7 +161,7 @@ overview}{wxfontencodingoverview} for the meaning of the last parameter).
 
 \docparam{weight}{One of {\bf wxNORMAL}, {\bf wxLIGHT} and {\bf wxBOLD}.}
 
 
 \docparam{weight}{One of {\bf wxNORMAL}, {\bf wxLIGHT} and {\bf wxBOLD}.}
 

-\docparam{underline}{The value can be TRUE or FALSE. At present this has an effect on Windows only.}
+\docparam{underline}{The value can be true or false. At present this has an effect on Windows and Motif 2.x only.}

 
 \docparam{faceName}{An optional string specifying the actual typeface to be used. If the empty string,
 a default typeface will chosen based on the family.}
 
 \docparam{faceName}{An optional string specifying the actual typeface to be used. If the empty string,
 a default typeface will chosen based on the family.}


@@ -144,7 +176,7 @@ is the encoding set by calls to
 say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
 default application encoding is the same as default system encoding.}
 \twocolitem{{\bf wxFONTENCODING\_ISO8859\_1...15}}{ISO8859 encodings.}
 say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
 default application encoding is the same as default system encoding.}
 \twocolitem{{\bf wxFONTENCODING\_ISO8859\_1...15}}{ISO8859 encodings.}

-\twocolitem{{\bf wxFONTENCODING\_KOI8}}{The standard russian encoding for Internet.}
+\twocolitem{{\bf wxFONTENCODING\_KOI8}}{The standard Russian encoding for Internet.}

 \twocolitem{{\bf wxFONTENCODING\_CP1250...1252}}{Windows encodings similar to ISO8859 (but not identical).}
 \end{twocollist}
 If the specified encoding isn't available, no font is created.
 \twocolitem{{\bf wxFONTENCODING\_CP1250...1252}}{Windows encodings similar to ISO8859 (but not identical).}
 \end{twocollist}
 If the specified encoding isn't available, no font is created.


@@ -153,7 +185,7 @@ If the specified encoding isn't available, no font is created.
 \wxheading{Remarks}
 
 If the desired font does not exist, the closest match will be chosen.
 \wxheading{Remarks}
 
 If the desired font does not exist, the closest match will be chosen.

-Under Windows, only scaleable TrueType fonts are used.
+Under Windows, only scalable TrueType fonts are used.

 
 See also \helpref{wxDC::SetFont}{wxdcsetfont}, \helpref{wxDC::DrawText}{wxdcdrawtext}
 and \helpref{wxDC::GetTextExtent}{wxdcgettextextent}.
 
 See also \helpref{wxDC::SetFont}{wxdcsetfont}, \helpref{wxDC::DrawText}{wxdcdrawtext}
 and \helpref{wxDC::GetTextExtent}{wxdcgettextextent}.


@@ -174,11 +206,18 @@ the application should try to clean up all fonts itself. This is because
 wxWindows cannot know if a pointer to the font object is stored in an
 application data structure, and there is a risk of double deletion.
 
 wxWindows cannot know if a pointer to the font object is stored in an
 application data structure, and there is a risk of double deletion.
 

+\membersection{wxFont::IsFixedWidth}\label{wxfontisfixedwidth}
+
+\constfunc{bool}{IsFixedWidth}{\void}
+
+Returns {\tt true} if the font is a fixed width (or monospaced) font, 
+{\tt false} if it is a proportional one or font is invalid.
+

 \membersection{wxFont::GetDefaultEncoding}\label{wxfontgetdefaultencoding}
 
 \func{static wxFontEncoding}{GetDefaultEncoding}{\void}
 
 \membersection{wxFont::GetDefaultEncoding}\label{wxfontgetdefaultencoding}
 
 \func{static wxFontEncoding}{GetDefaultEncoding}{\void}
 

-Returns the current applications default encoding.
+Returns the current application's default encoding.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -207,12 +246,16 @@ family identifiers.
 
 \helpref{wxFont::SetFamily}{wxfontsetfamily}
 
 
 \helpref{wxFont::SetFamily}{wxfontsetfamily}
 

-\membersection{wxFont::GetFontId}\label{wxfontgetfontid}
+\membersection{wxFont::GetNativeFontInfoDesc}\label{wxfontgetnativefontinfodesc}

 
 

-\constfunc{int}{GetFontId}{\void}
+\constfunc{wxString}{GetNativeFontInfoDesc}{\void}

 
 

-Returns the font id, if the portable font system is in operation. See \helpref{Font overview}{wxfontoverview} for
-further details.
+Returns the platform-dependent string completely describing this font or an
+empty string if the font wasn't constructed using the native font description.
+
+\wxheading{See also}
+
+\helpref{wxFont::SetNativeFontInfo}{wxfontsetnativefontinfo}

 
 \membersection{wxFont::GetPointSize}\label{wxfontgetpointsize}
 
 
 \membersection{wxFont::GetPointSize}\label{wxfontgetpointsize}
 


@@ -239,7 +282,7 @@ styles.
 
 \constfunc{bool}{GetUnderlined}{\void}
 
 
 \constfunc{bool}{GetUnderlined}{\void}
 

-Returns TRUE if the font is underlined, FALSE otherwise.
+Returns true if the font is underlined, false otherwise.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -256,6 +299,12 @@ weight identifiers.
 
 \helpref{wxFont::SetWeight}{wxfontsetweight}
 
 
 \helpref{wxFont::SetWeight}{wxfontsetweight}
 

+\membersection{wxFont::Ok}\label{wxfontok}
+
+\constfunc{bool}{Ok}{\void}
+
+Returns {\tt true} if this object is a valid font, {\tt false} otherwise.
+

 \membersection{wxFont::SetDefaultEncoding}\label{wxfontsetdefaultencoding}
 
 \func{static void}{SetDefaultEncoding}{\param{wxFontEncoding }{encoding}}
 \membersection{wxFont::SetDefaultEncoding}\label{wxfontsetdefaultencoding}
 
 \func{static void}{SetDefaultEncoding}{\param{wxFontEncoding }{encoding}}


@@ -312,6 +361,15 @@ Sets the font family.
 
 \helpref{wxFont::GetFamily}{wxfontgetfamily}, \helpref{wxFont::SetFaceName}{wxfontsetfacename}
 
 
 \helpref{wxFont::GetFamily}{wxfontgetfamily}, \helpref{wxFont::SetFaceName}{wxfontsetfacename}
 

+\membersection{wxFont::SetNativeFontInfo}\label{wxfontsetnativefontinfo}
+
+\func{void}{SetNativeFontInfo}{\param{const wxString\& }{info}}
+
+Creates the font corresponding to the given native font description string
+which must have been previously returned by 
+\helpref{GetNativeFontInfoDesc}{wxfontgetnativefontinfodesc}. If the string is
+invalid, font is unchanged.
+

 \membersection{wxFont::SetPointSize}\label{wxfontsetpointsize}
 
 \func{void}{SetPointSize}{\param{int}{ pointSize}}
 \membersection{wxFont::SetPointSize}\label{wxfontsetpointsize}
 
 \func{void}{SetPointSize}{\param{int}{ pointSize}}


@@ -348,7 +406,7 @@ Sets underlining.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{underlining}{TRUE to underline, FALSE otherwise.}
+\docparam{underlining}{true to underline, false otherwise.}

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -391,4 +449,3 @@ fail the test.
 Inequality operator. Two fonts are not equal if they contain pointers
 to different underlying font data. It does not compare each attribute.
 
 Inequality operator. Two fonts are not equal if they contain pointers
 to different underlying font data. It does not compare each attribute.
 

-