Whole bunch of minor doc updates from an external patch.

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

\section{\class{wxFontList}}\label{wxfontlist}

A font list is a list containing all fonts which have been created. There
is only one instance of this class: {\bf wxTheFontList}.  Use this object to search
for a previously created font of the desired type and create it if not already found.
In some windowing systems, the font may be a scarce resource, so it is best to
reuse old resources if possible.  When an application finishes, all fonts will be
deleted and their resources freed, eliminating the possibility of `memory leaks'.

\wxheading{Derived from}

\helpref{wxList}{wxlist}\\
\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/gdicmn.h>

\wxheading{See also}

\helpref{wxFont}{wxfont}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxFontList::wxFontList}\label{wxfontlistctor}

\func{}{wxFontList}{\void}

Constructor. The application should not construct its own font list:
use the object pointer {\bf wxTheFontList}.

\membersection{wxFontList::AddFont}\label{wxfontlistaddfont}

\func{void}{AddFont}{\param{wxFont *}{font}}

Used by wxWidgets to add a font to the list, called in the font constructor.

\membersection{wxFontList::FindOrCreateFont}\label{findorcreatefont}

\func{wxFont *}{FindOrCreateFont}{\param{int}{ point\_size}, \param{int}{ family}, \param{int}{ style}, \param{int}{ weight}, \param{bool}{ underline = false},
 \param{const wxString\& }{facename = NULL}, \param{wxFontEncoding }{encoding = wxFONTENCODING\_DEFAULT}{}}

Finds a font of the given specification, or creates one and adds it to the list. See the \helpref{wxFont constructor}{wxfontctor} for
details of the arguments.

\membersection{wxFontList::RemoveFont}\label{wxfontlistremovefont}

\func{void}{RemoveFont}{\param{wxFont *}{font}}

Used by wxWidgets to remove a font from the list.