Added drawing context to allow 'virtual' (dynamic) attributes, for e.g. showing bookm...

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

diff --git a/interface/wx/window.h b/interface/wx/window.h
index 0a3043e994f8b9b517e159752544fa763d47d9d3..7228e0edcb394638b9bbe59531c899b1c590e60d 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -491,10 +491,13 @@ public:
     */
     wxWindow* GetPrevSibling() const;
     /**
-        Reparents the window, i.e the window will be removed from its
+        Reparents the window, i.e. the window will be removed from its
         current parent window (e.g. a non-standard toolbar in a wxFrame)
         and then re-inserted into another.
 
+        Notice that currently you need to explicitly call
+        wxNotebook::RemovePage() before reparenting a notebook page.
+
         @param newParent
             New parent.
     */
@@ -1694,13 +1697,18 @@ public:
 
     /**
         Sets the background colour of the window.
+
+        Notice that as with SetForegroundColour(), setting the background
+        colour of a native control may not affect the entire control and could
+        be not supported at all depending on the control and platform.
+
         Please see InheritAttributes() for explanation of the difference between
         this method and SetOwnBackgroundColour().
 
         @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 
+            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
@@ -1777,6 +1785,13 @@ public:
 
     /**
         Sets the foreground colour of the window.
+
+        The meaning of foreground colour varies according to the window class;
+        it may be the text colour or other colour, or it may not be used at
+        all. Additionally, not all native controls support changing their
+        foreground colour so this method may change their colour only partially
+        or even not at all.
+
         Please see InheritAttributes() for explanation of the difference between
         this method and SetOwnForegroundColour().
 
@@ -1784,9 +1799,6 @@ public:
             The colour to be used as the foreground colour; pass
             wxNullColour to reset to the default colour.
 
-        @remarks The meaning of foreground colour varies 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.
 
@@ -2083,7 +2095,7 @@ public:
 
     /**
         Sets the style of the window. Please note that some styles cannot be changed
-        after the window creation and that Refresh() might need to be be called
+        after the window creation and that Refresh() might need to be called
         after changing the others for the change to take place immediately.
 
         See @ref overview_windowstyles "Window styles" for more information about flags.
@@ -2407,7 +2419,7 @@ public:
 
         @see GetToolTip(), wxToolTip
     */
-    void SetToolTip(const wxString& tip);
+    void SetToolTip(const wxString& tipString);
 
     /**
         @overload
@@ -2787,7 +2799,7 @@ public:
 
 
     /**
-        @name Constraints, sizers and window layouting functions
+        @name Constraints, sizers and window layout functions
     */
     //@{
 
@@ -2830,7 +2842,7 @@ public:
         This method calls SetSizer() and then wxSizer::SetSizeHints which sets the initial
         window size to the size needed to accommodate all sizer elements and sets the
         size hints which, if this window is a top level one, prevent the user from
-        resizing it to be less than this minimial size.
+        resizing it to be less than this minimal size.
     */
     void SetSizerAndFit(wxSizer* sizer, bool deleteOld = true);
 
@@ -3030,7 +3042,7 @@ public:
     /**
         Returns the platform-specific handle of the physical window.
         Cast it to an appropriate handle, such as @b HWND for Windows,
-        @b Widget for Motif, @b GtkWidget for GTK or @b WinHandle for PalmOS.
+        @b Widget for Motif or @b GtkWidget for GTK.
 
         @beginWxPerlOnly
         This method will return an integer in wxPerl.
@@ -3369,7 +3381,7 @@ protected:
 
         @remarks This function is not meant to be called directly by user code,
                  but via Centre, Center, CentreOnParent, or CenterOnParent.
-                 This function can be overriden to fine-tune centring behaviour.
+                 This function can be overridden to fine-tune centring behaviour.
     */
     virtual void DoCentre(int direction);