revision contributed by Utensil Candel

[wxWidgets.git] / interface / window.h

diff --git a/interface/window.h b/interface/window.h
index 17d68f60a03c5ab4730f5c62b49b6d14ee31df5c..ab5670b7dad4953a755dfa85f70775aeaab9f498 100644 (file)
--- a/interface/window.h
+++ b/interface/window.h
@@ -564,18 +564,23 @@ public:
     virtual void FitInside();
 
     /**
-        Freezes the window or, in other words, prevents any updates from taking place
-        on screen, the window is not redrawn at all. Thaw() must
-        be called to reenable window redrawing. Calls to these two functions may be
-        nested but to ensure that the window is properly repainted again, you must thaw
-        it exactly as many times as you froze it.
-        This method is useful for visual appearance optimization (for example, it
-        is a good idea to use it before doing many large text insertions in a row into
-        a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all
-        controls so it is mostly just a hint to wxWidgets and not a mandatory
-        directive.
-
-        @see wxWindowUpdateLocker
+        Freezes the window or, in other words, prevents any updates from taking
+        place on screen, the window is not redrawn at all.
+
+        Thaw() must be called to reenable window redrawing. Calls to these two
+        functions may be nested but to ensure that the window is properly
+        repainted again, you must thaw it exactly as many times as you froze
+        it.
+
+        If the window has any children, they are recursively frozen too.
+
+        This method is useful for visual appearance optimization (for example,
+        it is a good idea to use it before doing many large text insertions in
+        a row into a wxTextCtrl under wxGTK) but is not implemented on all
+        platforms nor for all controls so it is mostly just a hint to wxWidgets
+        and not a mandatory directive.
+
+        @see wxWindowUpdateLocker, Thaw(), IsFrozen()
     */
     virtual void Freeze();
 
@@ -1315,7 +1320,7 @@ public:
         Returns @true if the window is currently frozen by a call to
         Freeze().
 
-        @see Thaw()
+        @see Freeze(), Thaw()
     */
     virtual bool IsFrozen() const;
 
@@ -1376,16 +1381,6 @@ public:
     */
     void Layout();
 
-    /**
-        This is just a wrapper for wxWindow::ScrollLines(1).
-    */
-
-
-    /**
-        This is just a wrapper for wxWindow::ScrollLines(-1).
-    */
-
-
     /**
         Lowers the window to the bottom of the window hierarchy (Z-order).
 
@@ -1503,13 +1498,24 @@ public:
     virtual void OnInternalIdle();
 
     /**
-        This is just a wrapper for wxWindow::ScrollPages(1).
+        Same as #ScrollLines (-1).
     */
+    bool LineUp();
 
+    /**
+        Same as #ScrollLines (1).
+    */
+    bool LineDown();
 
     /**
-        This is just a wrapper for wxWindow::ScrollPages(-1).
+        Same as #ScrollPages (-1).
     */
+    bool PageUp();
+
+    /**
+        Same as #ScrollPages (1).
+    */
+    bool PageDown();
 
 
     /**
@@ -2025,7 +2031,7 @@ public:
         implementation,
         and not in the window object itself.
 
-        @see GetHelpText(), wxHelpProvider
+        @see GetHelpText(), wxHelpProvider::AddHelp()
     */
     virtual void SetHelpText(const wxString& helpText);
 
@@ -2461,11 +2467,14 @@ public:
                                 wxDirection dir = wxBOTTOM);
 
     /**
-        Reenables window updating after a previous call to
-        Freeze(). To really thaw the control, it must be called
-        exactly the same number of times as Freeze().
+        Reenables window updating after a previous call to Freeze().
+
+        To really thaw the control, it must be called exactly the same number
+        of times as Freeze().
+
+        If the window has any children, they are recursively thawn too.
 
-        @see wxWindowUpdateLocker
+        @see wxWindowUpdateLocker, Freeze(), IsFrozen()
     */
     virtual void Thaw();
 
@@ -2587,7 +2596,7 @@ public:
 
     /**
         Moves the pointer to the given position on the window.
-        @b NB: This function is not supported under Mac because Apple Human
+        @note This function is not supported under Mac because Apple Human
         Interface Guidelines forbid moving the mouse cursor programmatically.
 
         @param x
@@ -2604,27 +2613,32 @@ public:
 // Global functions/macros
 // ============================================================================
 
-/**
-    Find the deepest window at the given mouse position in screen coordinates,
-    returning the window if found, or @NULL if not.
-*/
-wxWindow* wxFindWindowAtPoint(const wxPoint& pt);
+/** @ingroup group_funcmacro_misc */
+//@{
 
 /**
     Find the deepest window at the mouse pointer position, returning the window
     and current pointer position in screen coordinates.
+
+    @header{wx/window.h}
 */
 wxWindow* wxFindWindowAtPointer(wxPoint& pt);
 
 /**
-    Gets the currently active window (implemented for MSW and GTK only currently,
-    always returns @NULL in the other ports).
+    Gets the currently active window (implemented for MSW and GTK only
+    currently, always returns @NULL in the other ports).
+
+    @header{wx/window.h}
 */
 wxWindow* wxGetActiveWindow();
 
 /**
-    Returns the first top level parent of the given window, or in other words, the
-    frame or dialog containing it, or @NULL.
+    Returns the first top level parent of the given window, or in other words,
+    the frame or dialog containing it, or @NULL.
+
+    @header{wx/window.h}
 */
-wxWindow* wxGetTopLevelParent(wxWindow win);
+wxWindow* wxGetTopLevelParent(wxWindow* window);
+
+//@}