Improved documentation for wxPGProperty::DoSetAttribute()

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

diff --git a/interface/wx/font.h b/interface/wx/font.h
index c814de2baae65577c1bb68e7b3a35c47108e9fee..a4283059b04279831ce8c50186ada7d5b18d2fe0 100644 (file)
--- a/interface/wx/font.h
+++ b/interface/wx/font.h
@@ -442,7 +442,9 @@ public:
 
     /**
         Returns the platform-dependent string completely describing this font.
 
     /**
         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.
 
         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 +455,9 @@ public:
 
     /**
         Returns a user-friendly string for this font object.
 
     /**
         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.
 
         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.


@@ -526,20 +530,29 @@ public:
     /**
         @name Similar fonts creation
 
     /**
         @name Similar fonts creation
 

-        The functions in this section create a font similar to the given one
-        but with its weight, style or size changed.
+        The functions in this section either modify the font in place or create
+        a new font similar to the given one but with its weight, style or size
+        changed.

      */
     //@{
 
     /**
         Return a bold version of this font.
      */
     //@{
 
     /**
         Return a bold version of this font.

+
+        @see MakeBold()
+
+        @since 2.9.1

      */
      */

-    wxFont MakeBold() const;
+    wxFont Bold() const;

 
     /**
         Return an italic version of this font.
 
     /**
         Return an italic version of this font.

+
+        @see MakeItalic()
+
+        @since 2.9.1

      */
      */

-    wxFont MakeItalic() const;
+    wxFont Italic() const;

 
     /**
         Return a larger version of this font.
 
     /**
         Return a larger version of this font.


@@ -547,9 +560,41 @@ public:
         The font size is multiplied by CSS specification inspired factor of @c
         1.2.
 
         The font size is multiplied by CSS specification inspired factor of @c
         1.2.
 

-        @see MakeSmaller(), Scale()
+        @see Larger(), MakeSmaller(), Scale()
+
+        @since 2.9.1
+     */
+    wxFont Larger() const;
+
+    /**
+        Changes this font to be bold.
+
+        @see Bold()
+
+        @since 2.9.1

      */
      */

-    wxFont MakeLarger() const;
+    wxFont& MakeBold();
+
+    /**
+        Changes this font to be italic.
+
+        @see Italic()
+
+        @since 2.9.1
+     */
+    wxFont& MakeItalic();
+
+    /**
+        Changes this font to be larger.
+
+        The font size is multiplied by CSS specification inspired factor of @c
+        1.2.
+
+        @see Larger(), MakeSmaller(), Scale()
+
+        @since 2.9.1
+     */
+    wxFont& MakeLarger();

 
     /**
         Return a smaller version of this font.
 
     /**
         Return a smaller version of this font.


@@ -557,17 +602,47 @@ public:
         The font size is divided by CSS specification inspired factor of @c
         1.2.
 
         The font size is divided by CSS specification inspired factor of @c
         1.2.
 

-        @see MakeLarger(), Scale()
+        @see MakeLarger(), Scale(), Smaller()
+
+        @since 2.9.1
+     */
+    wxFont& MakeSmaller();
+
+    /**
+        Changes the size 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).
+
+        @see Scaled(), MakeLarger(), MakeSmaller()
+
+        @since 2.9.1

      */
      */

-    wxFont MakeSmaller() const;
+    wxFont& Scale(float x);

 
     /**
         Return 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).
 
     /**
         Return 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).

+
+        @see Scale(), Larger(), Smaller()
+
+        @since 2.9.1
+     */
+    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 Scale(float x) const;
+    wxFont Smaller() const;

 
     //@}
 
 
     //@}