no changes, just come cleanup and more comments

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

diff --git a/docs/latex/wx/fontenum.tex b/docs/latex/wx/fontenum.tex
index f60c0f5c8b154977f1fc33bfcb837d63bba294bd..3605bf7e7c1cfefce2b93679307388fe78ad2bbc 100644 (file)
--- a/docs/latex/wx/fontenum.tex
+++ b/docs/latex/wx/fontenum.tex
@@ -22,7 +22,7 @@ To do this, you just have to call one of EnumerateXXX() functions - either
 corresponding callback (\helpref{OnFacename}{wxfontenumeratoronfacename} or 
 \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding}) will be called
 repeatedly until either all fonts satisfying the specified criteria are
-exhausted or the callback returns FALSE.
+exhausted or the callback returns false.
 
 \wxheading{Virtual functions to override}
 
@@ -41,6 +41,10 @@ None
 
 <wx/fontenum.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{Font encoding overview}{wxfontencodingoverview}, 
@@ -48,21 +52,24 @@ None
 \helpref{wxFont}{wxfont}, 
 \helpref{wxFontMapper}{wxfontmapper}
 
+
+
 \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
-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.
 
+
 \membersection{wxFontEnumerator::EnumerateEncodings}\label{wxfontenumeratorenumerateencodings}
 
 \func{virtual bool}{EnumerateEncodings}{\param{const wxString\& }{font = ""}}
@@ -74,21 +81,26 @@ least some font if {\it font} is not specified.
 
 \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 
-\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}
 
-\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 
-\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}
@@ -96,15 +108,13 @@ it to work if you overwrite that method.
 \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}
 
-\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
-each match. Return TRUE to continue enumeration or FALSE to stop it.
+each match. Return true to continue enumeration or false to stop it.