No docs yet, just the bare interace so we can get XML for Phoenix.

[wxWidgets.git] / interface / wx / font.h

diff --git a/interface/wx/font.h b/interface/wx/font.h
index f702fdb665169210f91658fc76af6514e277fd43..ffa5505743bb49e5a2af87a545742e9ac30ea394 100644 (file)
--- a/interface/wx/font.h
+++ b/interface/wx/font.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxFont
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
@@ -36,11 +36,9 @@ enum wxFontFamily
     /// See also wxFont::IsFixedWidth() for an easy way to test for monospace property.
     wxFONTFAMILY_TELETYPE = wxTELETYPE,
 
-    /// Returned by wxFont::GetFamily() when the face name of the font cannot
-    /// be classified into one of the previous wxFontFamily values.
-    wxFONTFAMILY_UNKNOWN = wxFONTFAMILY_MAX,
-
-    wxFONTFAMILY_MAX
+    /// Invalid font family value, returned by wxFont::GetFamily() when the
+    /// font is invalid for example.
+    wxFONTFAMILY_UNKNOWN
 };
 
 /**
@@ -237,13 +235,10 @@ enum wxFontEncoding
     /// (this is used by wxEncodingConverter and wxUTFFile only for now)
     wxFONTENCODING_UNICODE,
 
-    // alternative names for Far Eastern encodings
-    // Chinese
     wxFONTENCODING_GB2312 = wxFONTENCODING_CP936, //!< Simplified Chinese
     wxFONTENCODING_BIG5 = wxFONTENCODING_CP950,   //!< Traditional Chinese
-
-        // Japanese (see http://zsigri.tripod.com/fontboard/cjk/jis.html)
-    wxFONTENCODING_SHIFT_JIS = wxFONTENCODING_CP932 //!< Shift JIS
+    wxFONTENCODING_SHIFT_JIS = wxFONTENCODING_CP932, //!< Shift JIS
+    wxFONTENCODING_EUC_KR = wxFONTENCODING_CP949 //!< Korean
 };
 
 
@@ -425,16 +420,17 @@ public:
     virtual wxString GetFaceName() const;
 
     /**
-        Gets the font family.
+        Gets the font family if possible.
+
         As described in ::wxFontFamily docs the returned value acts as a rough,
         basic classification of the main font properties (look, spacing).
 
         If the current font face name is not recognized by wxFont or by the
-        underlying system, @c wxFONTFAMILY_UNKNOWN is returned.
+        underlying system, @c wxFONTFAMILY_DEFAULT is returned.
 
-        Note that currently this function is rather unreliable (@c wxFONTFAMILY_UNKNOWN
-        is returned in too many cases) and not particularly useful.
-        Font families mostly make sense only for font creation; see SetFamily().
+        Note that currently this function is not very precise and so not
+        particularly useful. Font families mostly make sense only for font
+        creation, see SetFamily().
 
         @see SetFamily()
     */
@@ -442,7 +438,9 @@ public:
 
     /**
         Returns the platform-dependent string completely describing this font.
-        Returned string is always non-empty.
+
+        Returned string is always non-empty unless the font is invalid (in
+        which case an assert is triggered).
 
         Note that the returned string is not meant to be shown or edited by the user: a
         typical use of this function is for serializing in string-form a wxFont object.
@@ -453,7 +451,9 @@ public:
 
     /**
         Returns a user-friendly string for this font object.
-        Returned string is always non-empty.
+
+        Returned string is always non-empty unless the font is invalid (in
+        which case an assert is triggered).
 
         The string does not encode all wxFont infos under all platforms;
         e.g. under wxMSW the font family is not present in the returned string.
@@ -533,7 +533,7 @@ public:
     //@{
 
     /**
-        Return a bold version of this font.
+        Returns a bold version of this font.
 
         @see MakeBold()
 
@@ -542,7 +542,7 @@ public:
     wxFont Bold() const;
 
     /**
-        Return an italic version of this font.
+        Returns an italic version of this font.
 
         @see MakeItalic()
 
@@ -551,17 +551,29 @@ public:
     wxFont Italic() const;
 
     /**
-        Return a larger version of this font.
+        Returns a larger version of this font.
 
-        The font size is multiplied by CSS specification inspired factor of @c
-        1.2.
+        The font size is multiplied by @c 1.2, the factor of @c 1.2 being
+        inspired by the W3C CSS specification.
 
-        @see Larger(), MakeSmaller(), Scale()
+        @see MakeLarger(), Smaller(), Scaled()
 
         @since 2.9.1
      */
     wxFont Larger() const;
 
+    /**
+        Returns a smaller version of this font.
+
+        The font size is divided by @c 1.2, the factor of @c 1.2 being
+        inspired by the W3C CSS specification.
+
+        @see MakeSmaller(), Larger(), Scaled()
+
+        @since 2.9.1
+     */
+    wxFont Smaller() const;
+
     /**
         Changes this font to be bold.
 
@@ -583,8 +595,8 @@ public:
     /**
         Changes this font to be larger.
 
-        The font size is multiplied by CSS specification inspired factor of @c
-        1.2.
+        The font size is multiplied by @c 1.2, the factor of @c 1.2 being
+        inspired by the W3C CSS specification.
 
         @see Larger(), MakeSmaller(), Scale()
 
@@ -593,12 +605,12 @@ public:
     wxFont& MakeLarger();
 
     /**
-        Return a smaller version of this font.
+        Changes this font to be smaller.
 
-        The font size is divided by CSS specification inspired factor of @c
-        1.2.
+        The font size is divided by @c 1.2, the factor of @c 1.2 being
+        inspired by the W3C CSS specification.
 
-        @see MakeLarger(), Scale(), Smaller()
+        @see Smaller(), MakeLarger(), Scale()
 
         @since 2.9.1
      */
@@ -617,7 +629,7 @@ public:
     wxFont& Scale(float x);
 
     /**
-        Return a scaled version of this font.
+        Returns a scaled version of this font.
 
         The font size is multiplied by the given factor (which may be less than
         1 to create a smaller version of the font).
@@ -628,18 +640,6 @@ public:
      */
     wxFont Scaled(float x) const;
 
-    /**
-        Return a smaller version of this font.
-
-        The font size is divided by CSS specification inspired factor of @c
-        1.2.
-
-        @see Larger(), MakeSmaller(), Scaled()
-
-        @since 2.9.1
-     */
-    wxFont Smaller() const;
-
     //@}
 
     /**