]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/fontenum.h
Mention graphics device classes
[wxWidgets.git] / interface / fontenum.h
index 3f82b66076aa31dc9476fbc326f7079dc3df32e9..8cf2da6104d000034522feecea414413d76713fc 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        fontenum.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        fontenum.h
-// Purpose:     documentation for wxFontEnumerator class
+// Purpose:     interface of wxFontEnumerator
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,67 +9,65 @@
 /**
     @class wxFontEnumerator
     @wxheader{fontenum.h}
 /**
     @class wxFontEnumerator
     @wxheader{fontenum.h}
-    
+
     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
     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.
-    
-    To do this, you just have to call one of EnumerateXXX() functions - either 
-    wxFontEnumerator::EnumerateFacenames or 
+    the given encoding().
+
+    To do this, you just have to call one of EnumerateXXX() functions - either
+    wxFontEnumerator::EnumerateFacenames or
     wxFontEnumerator::EnumerateEncodings and the
     wxFontEnumerator::EnumerateEncodings and the
-    corresponding callback (wxFontEnumerator::OnFacename or 
+    corresponding callback (wxFontEnumerator::OnFacename or
     wxFontEnumerator::OnFontEncoding) will be called
     repeatedly until either all fonts satisfying the specified criteria are
     exhausted or the callback returns @false.
     wxFontEnumerator::OnFontEncoding) will be called
     repeatedly until either all fonts satisfying the specified criteria are
     exhausted or the callback returns @false.
-    
+
     @library{wxcore}
     @category{FIXME}
     @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 
+class wxFontEnumerator
 {
 public:
     /**
         Call OnFontEncoding() for each
         encoding supported by the given font - or for each encoding supported by at
 {
 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
     */
     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,
         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 
+        Return array of strings containing all encodings found by
         EnumerateEncodings().
     */
     static wxArrayString GetEncodings(const wxString& facename = "");
 
     /**
         EnumerateEncodings().
     */
     static wxArrayString GetEncodings(const wxString& facename = "");
 
     /**
-        Return array of strings containing all facenames found by 
+        Return array of strings containing all facenames found by
         EnumerateFacenames().
     */
     static wxArrayString GetFacenames(wxFontEncoding encoding = wxFONTENCODING_SYSTEM,
         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.
     */
 
     /**
         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
 
     /**
         Called by EnumerateFacenames() for
@@ -84,3 +82,4 @@ public:
     virtual bool OnFontEncoding(const wxString& font,
                                 const wxString& encoding);
 };
     virtual bool OnFontEncoding(const wxString& font,
                                 const wxString& encoding);
 };
+