Updated docs for Set[Fore|Back]groundColour with more hints about

using them with themes

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

diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex
index e32ce366dd77c6f626fcac32e511536d970ef85c..4c4ca4c1bf89a1abc8c8b0c0f9f84afd7a7e3a4c 100644 (file)
--- a/docs/latex/wx/window.tex
+++ b/docs/latex/wx/window.tex
@@ -2362,7 +2362,8 @@ explanation of the difference between this method and
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{colour}{The colour to be used as the background colour.}
+\docparam{colour}{The colour to be used as the background colour, pass
+  {\tt wxNullColour} to reset to the default colour.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -2374,9 +2375,11 @@ Note that setting the background colour does not cause an immediate refresh, so
 may wish to call \helpref{wxWindow::ClearBackground}{wxwindowclearbackground} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
 calling this function.
 
 may wish to call \helpref{wxWindow::ClearBackground}{wxwindowclearbackground} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after
 calling this function.
 

-Use this function with care under GTK+ as the new appearance of the window might
-not look equally well when used with "Themes", i.e GTK+'s ability to change its
-look as the user wishes with run-time loadable modules.
+Using this function will disable attempts to use themes for this
+window, if the system supports them.  Use with care since usually the
+themes represent the appearance chosen by the user to be used for all
+applications on the system.
+

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -2650,7 +2653,8 @@ explanation of the difference between this method and
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{colour}{The colour to be used as the foreground colour.}
+\docparam{colour}{The colour to be used as the foreground colour, pass
+  {\tt wxNullColour} to reset to the default colour.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -2658,9 +2662,10 @@ The interpretation of foreground colour is open to interpretation according
 to the window class; it may be the text colour or other colour, or it may not
 be used at all.
 
 to the window class; it may be the text colour or other colour, or it may not
 be used at all.
 

-Note that when using this functions under GTK, you will disable the so called "themes",
-i.e. the user chosen appearance of windows and controls, including the themes of
-their parent windows.
+Using this function will disable attempts to use themes for this
+window, if the system supports them.  Use with care since usually the
+themes represent the appearance chosen by the user to be used for all
+applications on the system.

 
 \wxheading{See also}
 
 
 \wxheading{See also}