X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3c1866e88fb77fc7e0b349cc15f6cebf0f727a9d..819451b6c76bdcaf5fd8865479209859511aa986:/docs/latex/wx/fontenum.tex?ds=sidebyside diff --git a/docs/latex/wx/fontenum.tex b/docs/latex/wx/fontenum.tex index ecb2552bd9..b697b74ec9 100644 --- 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 -%% Licence: wxWindows licence +%% License: wxWindows license %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% \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 -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} @@ -55,11 +54,11 @@ None \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. @@ -72,21 +71,40 @@ Call \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding} for each 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.