%% Created: 03.11.99
%% RCS-ID: $Id$
%% Copyright: (c) Vadim Zeitlin
-%% Licence: wxWindows licence
+%% License: wxWidgets license
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{\class{wxFontEnumerator}}\label{wxfontenumerator}
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
-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}
\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 {\it fixedWidthOnly} is true).
Calling this function with default arguments will result in enumerating all
fonts available on the system.
encoding supported by the given font - or for each encoding supported by at
least some font if {\it font} is not specified.
+
+\membersection{wxFontEnumerator::GetEncodings}\label{wxfontenumeratorgetencodings}
+
+\func{wxArrayString*}{GetEncodings}{\void}
+
+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.
+
+\membersection{wxFontEnumerator::GetFacenames}\label{wxfontenumeratorgetfacenames}
+
+\func{wxArrayString*}{GetFacenames}{\void}
+
+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.
+
+
\membersection{wxFontEnumerator::OnFacename}\label{wxfontenumeratoronfacename}
\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}
+ \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.