Generalized wxScrolledWindow into wxScrolled<T> that can derive from

[wxWidgets.git] / interface / window.h

diff --git a/interface/window.h b/interface/window.h
index 894a30480314ae0d42a5dd5d83dacc9e30d2d75d..657d9efa464469616bb0744b8c8ec7fd5a09bb2e 100644 (file)
--- a/interface/window.h
+++ b/interface/window.h
@@ -697,7 +697,7 @@ public:
         ignore under other platforms. Under Mac, it will change the size of the
         returned font. See SetWindowVariant()
         for more about this.
-        This static method is "overridden'' in many derived classes and so calling,
+        This static method is "overridden" in many derived classes and so calling,
         for example, wxButton::GetClassDefaultAttributes() will typically
         return the values appropriate for a button which will be normally different
         from those returned by, say, wxListCtrl::GetClassDefaultAttributes().
@@ -755,7 +755,7 @@ public:
         the call is automatically dispatched to the correct class (as usual with
         virtual functions) and you don't have to specify the class name explicitly.
         The other one is that in the future this function could return different
-        results, for example it might return a different font for an "Ok'' button
+        results, for example it might return a different font for an "Ok" button
         than for a generic button if the users GUI is configured to show such buttons
         in bold font. Of course, the down side is that it is impossible to call this
         function without actually having an object to apply it to whereas the static
@@ -1249,7 +1249,7 @@ public:
         This function is (or should be, in case of custom controls) called during
         window creation to intelligently set up the window visual attributes, that is
         the font and the foreground and background colours.
-        By "intelligently'' the following is meant: by default, all windows use their
+        By "intelligently" the following is meant: by default, all windows use their
         own @ref getclassdefaultattributes() default attributes. However
         if some of the parents attributes are explicitly (that is, using
         SetFont() and not
@@ -1381,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).
 
@@ -1508,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();
 
 
     /**
@@ -2595,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
@@ -2612,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);
+
+//@}