]> git.saurik.com Git - wxWidgets.git/commitdiff
Add or fix descriptions of return values from SetFont/XXXColour().
authorVadim Zeitlin <vadim@wxwidgets.org>
Wed, 21 Oct 2009 09:44:07 +0000 (09:44 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Wed, 21 Oct 2009 09:44:07 +0000 (09:44 +0000)
Add the same kind of description to SetBackground/ForegroundColour() as in
SetFont() and fix typo in the latter.

Closes #11352.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@62462 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/window.h

index a40cace842a82fe9c6fd8c25e634c6989f0f6992..ed15f4adb039c6fe16c3c92673fc206a3a0e6a5d 100644 (file)
@@ -1625,6 +1625,9 @@ public:
                  usually the themes represent the appearance chosen by the user
                  to be used for all applications on the system.
 
                  usually the themes represent the appearance chosen by the user
                  to be used for all applications on the system.
 
+        @return @true if the colour was really changed, @false if it was already set
+                to this colour and nothing was done.
+
         @see GetBackgroundColour(), SetForegroundColour(),
              GetForegroundColour(), ClearBackground(),
              Refresh(), wxEraseEvent
         @see GetBackgroundColour(), SetForegroundColour(),
              GetForegroundColour(), ClearBackground(),
              Refresh(), wxEraseEvent
@@ -1676,8 +1679,8 @@ public:
             Font to associate with this window, pass
             wxNullFont to reset to the default font.
 
             Font to associate with this window, pass
             wxNullFont to reset to the default font.
 
-        @return @true if the want was really changed, @false if it was already set
-                to this  font and so nothing was done.
+        @return @true if the font was really changed, @false if it was already set
+                to this font and nothing was done.
 
         @see GetFont(), InheritAttributes()
     */
 
         @see GetFont(), InheritAttributes()
     */
@@ -1696,6 +1699,9 @@ public:
                  interpretation according to the window class; it may be
                  the text colour or other colour, or it may not be used at all.
 
                  interpretation according to the window class; it may be
                  the text colour or other colour, or it may not be used at all.
 
+        @return @true if the colour was really changed, @false if it was already set
+                to this colour and nothing was done.
+
         @see GetForegroundColour(), SetBackgroundColour(),
              GetBackgroundColour(), ShouldInheritColours()
     */
         @see GetForegroundColour(), SetBackgroundColour(),
              GetBackgroundColour(), ShouldInheritColours()
     */