X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..3f16e52c1396f7d58b29b2eea22d7715f0f4596b:/interface/fontenum.h diff --git a/interface/fontenum.h b/interface/fontenum.h index 1ab4b739d4..8cf2da6104 100644 --- a/interface/fontenum.h +++ b/interface/fontenum.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: fontenum.h -// Purpose: documentation for wxFontEnumerator class +// Purpose: interface of wxFontEnumerator // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -13,7 +13,7 @@ wxFontEnumerator enumerates either all available fonts on the system or only the ones with given attributes - either only fixed-width (suited for use in programs such as terminal emulators and the like) or the fonts available in - the given encoding. + the given encoding(). To do this, you just have to call one of EnumerateXXX() functions - either wxFontEnumerator::EnumerateFacenames or @@ -26,9 +26,8 @@ @library{wxcore} @category{FIXME} - @seealso - @ref overview_wxfontencodingoverview "Font encoding overview", @ref - overview_samplefont "Font sample", wxFont, wxFontMapper + @see @ref overview_wxfontencodingoverview, @ref overview_samplefont "Font + sample", wxFont, wxFontMapper */ class wxFontEnumerator { @@ -36,20 +35,19 @@ public: /** Call OnFontEncoding() for each encoding supported by the given font - or for each encoding supported by at - least some font if @e font is not specified. + least some font if @a font is not specified. */ virtual bool EnumerateEncodings(const wxString& font = ""); /** Call OnFacename() for each font which supports given encoding (only if it is not wxFONTENCODING_SYSTEM) and is of - fixed width (if @e fixedWidthOnly is @true). - + fixed width (if @a fixedWidthOnly is @true). Calling this function with default arguments will result in enumerating all fonts available on the system. */ virtual bool EnumerateFacenames(wxFontEncoding encoding = wxFONTENCODING_SYSTEM, - bool fixedWidthOnly = @false); + bool fixedWidthOnly = false); /** Return array of strings containing all encodings found by @@ -62,14 +60,14 @@ public: EnumerateFacenames(). */ static wxArrayString GetFacenames(wxFontEncoding encoding = wxFONTENCODING_SYSTEM, - bool fixedWidthOnly = @false); + bool fixedWidthOnly = false); /** 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 wxFont::SetFaceName. */ - static bool IsValidFacename(const wxString & facename); + static bool IsValidFacename(const wxString& facename); /** Called by EnumerateFacenames() for @@ -84,3 +82,4 @@ public: virtual bool OnFontEncoding(const wxString& font, const wxString& encoding); }; +