mention wxSystemSettings::GetColour() in wxWindow::SetBackgroundColour() docs

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

diff --git a/interface/wx/window.h b/interface/wx/window.h
index 88c3053acda8a76c51588ad844cb576aa7561996..6a2cc7216c8296cbbc8ffffe409f9cc78b5edb6e 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -1633,6 +1633,8 @@ public:
         @param colour
             The colour to be used as the background colour; pass
             wxNullColour to reset to the default colour.
+            Note that you may want to use wxSystemSettings::GetColour() to retrieve 
+            a suitable colour to use rather than setting an hard-coded one.
 
         @remarks The background colour is usually painted by the default
                  wxEraseEvent event handler function under Windows and
@@ -1650,32 +1652,32 @@ public:
 
         @see GetBackgroundColour(), SetForegroundColour(),
              GetForegroundColour(), ClearBackground(),
-             Refresh(), wxEraseEvent
+             Refresh(), wxEraseEvent, wxSystemSettings
     */
     virtual bool SetBackgroundColour(const wxColour& colour);
 
     /**
         Sets the background style of the window.
 
-        The default background style is wxBG_STYLE_ERASE which indicates that
-        the window background may be erased in EVT_ERASE_BACKGROUND handler.
+        The default background style is @c wxBG_STYLE_ERASE which indicates that
+        the window background may be erased in @c EVT_ERASE_BACKGROUND handler.
         This is a safe, compatibility default; however you may want to change it
-        to wxBG_STYLE_SYSTEM if you don't define any erase background event
+        to @c wxBG_STYLE_SYSTEM if you don't define any erase background event
         handlers at all, to avoid unnecessary generation of erase background
         events and always let system erase the background. And you should
-        change the background style to wxBG_STYLE_PAINT if you define an
-        EVT_PAINT handler which completely overwrites the window background as
-        in this case erasing it previously, either in EVT_ERASE_BACKGROUND
+        change the background style to @c wxBG_STYLE_PAINT if you define an
+        @c EVT_PAINT handler which completely overwrites the window background as
+        in this case erasing it previously, either in @c EVT_ERASE_BACKGROUND
         handler or in the system default handler, would result in flicker as
         the background pixels will be repainted twice every time the window is
         redrawn. Do ensure that the background is entirely erased by your
-        EVT_PAINT handler in this case however as otherwise garbage may be left
+        @c EVT_PAINT handler in this case however as otherwise garbage may be left
         on screen.
 
         Notice that in previous versions of wxWidgets a common way to work
         around the above mentioned flickering problem was to define an empty
-        EVT_ERASE_BACKGROUND handler. Setting background style to
-        wxBG_STYLE_PAINT is a simpler and more efficient solution to the same
+        @c EVT_ERASE_BACKGROUND handler. Setting background style to
+        @c wxBG_STYLE_PAINT is a simpler and more efficient solution to the same
         problem.
 
         @see SetBackgroundColour(), GetForegroundColour(),