X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/775a998ed0b5332053b4e3ac850a00dd9727e670..a9249b2eb2a40d8c71f828669045c4ddaa8dc5ff:/docs/latex/wx/fontenum.tex diff --git a/docs/latex/wx/fontenum.tex b/docs/latex/wx/fontenum.tex index 396ff626c2..f60c0f5c8b 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} @@ -17,20 +17,19 @@ programs such as terminal emulators and the like) or the fonts available in the given \helpref{encoding}{wxfontencodingoverview}. To do this, you just have to call one of EnumerateXXX() functions - either -\helpref{EnumerateFamilies}{wxfontenumeratorenumeratefamilies} or +\helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} or \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings} and the -corresponding callback ( -\helpref{OnFontFamily}{wxFontEnumeratoronfontfamily} or +corresponding callback (\helpref{OnFacename}{wxfontenumeratoronfacename} or \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding}) will be called -repeatedly until either all fonts (satisfying the specified criteria) are +repeatedly until either all fonts satisfying the specified criteria are exhausted or the callback returns FALSE. \wxheading{Virtual functions to override} -Either \helpref{OnFontFamily}{wxfontenumeratoronfontfamily} or +Either \helpref{OnFacename}{wxfontenumeratoronfacename} or \helpref{OnFontEncoding}{wxfontenumeratoronfontencoding} should be overridden depending on whether you plan to call -\helpref{EnumerateFamilies}{wxfontenumeratorenumeratefamilies} or +\helpref{EnumerateFacenames}{wxfontenumeratorenumeratefacenames} or \helpref{EnumerateEncodings}{wxfontenumeratorenumerateencodings}. Of course, if you call both of them, you should override both functions. @@ -51,13 +50,13 @@ None \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxFontEnumerator::EnumerateFamilies}\label{wxfontenumeratorenumeratefamilies} +\membersection{wxFontEnumerator::EnumerateFacenames}\label{wxfontenumeratorenumeratefacenames} -\func{virtual bool}{EnumerateFamilies}{ +\func{virtual bool}{EnumerateFacenames}{ \param{wxFontEncoding }{encoding = wxFONTENCODING\_SYSTEM}, \param{bool }{fixedWidthOnly = FALSE}} -Call \helpref{OnFontFamily}{wxfontenumeratoronfontfamily} for each font which +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). @@ -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::OnFontFamily}\label{wxfontenumeratoronfontfamily} -\func{virtual bool}{OnFontFamily}{\param{const wxString\& }{font}} +\membersection{wxFontEnumerator::GetEncodings}\label{wxfontenumeratorgetencodings} -Called by \helpref{EnumerateFamilies}{wxfontenumeratorenumeratefamilies} for +\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. \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. -