Wine fixes

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

diff --git a/docs/latex/wx/fontenum.tex b/docs/latex/wx/fontenum.tex
index 54ca070cd3c04df01d3762db14cdbb327795e8e9..12f3a90c905ffd4e45a06d51eed9c9f8cc626eae 100644 (file)
--- a/docs/latex/wx/fontenum.tex
+++ b/docs/latex/wx/fontenum.tex
@@ -6,7 +6,7 @@
 %% Created:     03.11.99
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
 %% Created:     03.11.99
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin

-%% Licence:     wxWindows licence
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFontEnumerator}}\label{wxfontenumerator}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFontEnumerator}}\label{wxfontenumerator}


@@ -19,11 +19,10 @@ the given \helpref{encoding}{wxfontencodingoverview}.
 To do this, you just have to call one of EnumerateXXX() functions - either 
 \helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} or 
 \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} and the
 To do this, you just have to call one of EnumerateXXX() functions - either 
 \helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} or 
 \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} and the

-corresponding callback ( 
-\helpref{OnFacename}{wxFontEnumeratoronfacename} or
+corresponding callback (\helpref{OnFacename}{wxfontenumeratoronfacename} or 

 \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding}) will be called
 \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding}) will be called

-repeatedly until either all fonts (satisfying the specified criteria) are
-exhausted or the callback returns FALSE.
+repeatedly until either all fonts satisfying the specified criteria are
+exhausted or the callback returns false.

 
 \wxheading{Virtual functions to override}
 
 
 \wxheading{Virtual functions to override}
 


@@ -49,21 +48,24 @@ None
 \helpref{wxFont}{wxfont}, 
 \helpref{wxFontMapper}{wxfontmapper}
 
 \helpref{wxFont}{wxfont}, 
 \helpref{wxFontMapper}{wxfontmapper}
 

+
+

 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxFontEnumerator::EnumerateFacenames}\label{wxfontenumeratorenumeratefacenames}
 
 \func{virtual bool}{EnumerateFacenames}{
     \param{wxFontEncoding }{encoding = wxFONTENCODING\_SYSTEM},
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \membersection{wxFontEnumerator::EnumerateFacenames}\label{wxfontenumeratorenumeratefacenames}
 
 \func{virtual bool}{EnumerateFacenames}{
     \param{wxFontEncoding }{encoding = wxFONTENCODING\_SYSTEM},

-    \param{bool }{fixedWidthOnly = FALSE}}
+    \param{bool }{fixedWidthOnly = false}}

 
 Call \helpref{OnFacename}{wxfontenumeratoronfacename} for each font which
 supports given encoding (only if it is not wxFONTENCODING\_SYSTEM) and is of
 
 Call \helpref{OnFacename}{wxfontenumeratoronfacename} for each font which
 supports given encoding (only if it is not wxFONTENCODING\_SYSTEM) and is of

-fixed width (if {\it fixedWidthOnly} is TRUE).
+fixed width (if \arg{fixedWidthOnly} is true).

 
 Calling this function with default arguments will result in enumerating all
 fonts available on the system.
 
 
 Calling this function with default arguments will result in enumerating all
 fonts available on the system.
 

+

 \membersection{wxFontEnumerator::EnumerateEncodings}\label{wxfontenumeratorenumerateencodings}
 
 \func{virtual bool}{EnumerateEncodings}{\param{const wxString\& }{font = ""}}
 \membersection{wxFontEnumerator::EnumerateEncodings}\label{wxfontenumeratorenumerateencodings}
 
 \func{virtual bool}{EnumerateEncodings}{\param{const wxString\& }{font = ""}}


@@ -75,21 +77,26 @@ least some font if {\it font} is not specified.
 
 \membersection{wxFontEnumerator::GetEncodings}\label{wxfontenumeratorgetencodings}
 
 
 \membersection{wxFontEnumerator::GetEncodings}\label{wxfontenumeratorgetencodings}
 

-\func{wxArrayString*}{GetEncodings}{\void}
+\func{static wxArrayString}{GetEncodings}{\param{const wxString\&}{ facename = ""}}

 
 Return array of strings containing all encodings found by 
 
 Return array of strings containing all encodings found by 

-\helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings}. This is convenience function. It is 
-based on default implementation of \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding} so don't expect
-it to work if you overwrite that method.
+\helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings}.
+

 
 \membersection{wxFontEnumerator::GetFacenames}\label{wxfontenumeratorgetfacenames}
 
 
 \membersection{wxFontEnumerator::GetFacenames}\label{wxfontenumeratorgetfacenames}
 

-\func{wxArrayString*}{GetFacenames}{\void}
+\func{static wxArrayString}{GetFacenames}{\param{wxFontEncoding }{encoding = wxFONTENCODING\_SYSTEM}, \param{bool }{fixedWidthOnly = false}}

 
 Return array of strings containing all facenames found by 
 
 Return array of strings containing all facenames found by 

-\helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames}. This is convenience function. It is 
-based on default implementation of \helpref{OnFacename}{wxfontenumeratoronfacename} so don't expect
-it to work if you overwrite that method.
+\helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames}.
+
+
+\membersection{wxFontEnumerator::IsValidFacename}\label{wxfontenumeratorisvalidfacename}
+
+\func{static bool}{IsValidFacename}{\param{const wxString \&}{ facename}}
+
+Returns \true if the given string is valid face name, i.e. it's the face name of an installed
+font and it can safely be used with \helpref{wxFont::SetFaceName}{wxfontsetfacename}.

 
 
 \membersection{wxFontEnumerator::OnFacename}\label{wxfontenumeratoronfacename}
 
 
 \membersection{wxFontEnumerator::OnFacename}\label{wxfontenumeratoronfacename}


@@ -97,15 +104,13 @@ it to work if you overwrite that method.
 \func{virtual bool}{OnFacename}{\param{const wxString\& }{font}}
 
 Called by \helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} for
 \func{virtual bool}{OnFacename}{\param{const wxString\& }{font}}
 
 Called by \helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} for

-each match. Return TRUE to continue enumeration or FALSE to stop it.
+each match. Return true to continue enumeration or false to stop it.
+

 
 \membersection{wxFontEnumerator::OnFontEncoding}\label{wxfontenumeratoronfontencoding}
 
 
 \membersection{wxFontEnumerator::OnFontEncoding}\label{wxfontenumeratoronfontencoding}
 

-\func{virtual bool}{OnFontEncoding}{
- \param{const wxString\& }{font},
- \param{const wxString\& }{encoding}
-}
+\func{virtual bool}{OnFontEncoding}{\param{const wxString\& }{font}, \param{const wxString\& }{encoding}}

 
 Called by \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} for
 
 Called by \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} for

-each match. Return TRUE to continue enumeration or FALSE to stop it.
+each match. Return true to continue enumeration or false to stop it.