Make storing non-trivial data in wxThreadSpecificInfo possible.

[wxWidgets.git] / interface / wx / ribbon / page.h

diff --git a/interface/wx/ribbon/page.h b/interface/wx/ribbon/page.h
index 04a025418376777d38b398b23e29c1579619caad..c6e2845342b0afffe8caa32a0f344c979e2cbe86 100644 (file)
--- a/interface/wx/ribbon/page.h
+++ b/interface/wx/ribbon/page.h
@@ -2,7 +2,6 @@
 // Name:        ribbon/page.h
 // Purpose:     interface of wxRibbonPage
 // Author:      Peter Cawley
-// RCS-ID:      $Id$
 // Licence:     wxWindows licence
 ///////////////////////////////////////////////////////////////////////////////
 
@@ -77,7 +76,7 @@ public:
 
     /**
         Get the icon used for the page in the ribbon bar tab area (only
-        displayed if the ribbon bar is actuallt showing icons).
+        displayed if the ribbon bar is actually showing icons).
     */
     wxBitmap& GetIcon();
   
@@ -86,7 +85,7 @@ public:
     
         When a page is too small to display all of its children, scroll buttons
         will appear (and if the page is sized up enough, they will disappear again).
-        Slightly counter-intuively, these buttons are created as siblings of the
+        Slightly counter-intuitively, these buttons are created as siblings of the
         page rather than children of the page (to achieve correct cropping and
         paint ordering of the children and the buttons). When there are no scroll
         buttons, this function behaves the same as SetSize(), however when there
@@ -94,7 +93,7 @@ public:
         then calls SetSize() with the remaining area.
     
         This is provided as a separate function to SetSize() rather than within
-        the implementation of SetSize(), as iteracting algorithms may not expect
+        the implementation of SetSize(), as interacting algorithms may not expect
         SetSize() to also set the size of siblings.
     */
     void SetSizeWithScrollButtonAdjustment(int x, int y, int width, int height);
@@ -138,7 +137,7 @@ public:
         Scroll the page by some amount up / down / left / right.
     
         When the page's children are too big to fit in the onscreen area given to
-        the page, scroll buttons will appear, and the page can be programatically
+        the page, scroll buttons will appear, and the page can be programmatically
         scrolled. Positive values of @a lines will scroll right or down, while
         negative values will scroll up or left (depending on the direction in which
         panels are stacked). A line is equivalent to a constant number of pixels.
@@ -148,6 +147,7 @@ public:
     
         @see GetMajorAxis()
         @see ScrollPixels()
+        @see ScrollSections()
     */
     virtual bool ScrollLines(int lines);
   
@@ -155,7 +155,7 @@ public:
         Scroll the page by a set number of pixels up / down / left / right.
     
         When the page's children are too big to fit in the onscreen area given to
-        the page, scroll buttons will appear, and the page can be programatically
+        the page, scroll buttons will appear, and the page can be programmatically
         scrolled. Positive values of @a lines will scroll right or down, while
         negative values will scroll up or left (depending on the direction in which
         panels are stacked).
@@ -165,9 +165,27 @@ public:
     
         @see GetMajorAxis()
         @see ScrollLines()
+        @see ScrollSections()
     */
     bool ScrollPixels(int pixels);
 
+    /**
+        Scroll the page by an entire child section.
+
+        The @a sections parameter value should be 1 or -1. This will scroll
+        enough to uncover a partially visible child section or totally uncover
+        the next child section that may not be visible at all.
+
+        @return @true if the page scrolled at least one pixel in the given
+            direction, @false if it did not scroll.
+
+        @see ScrollPixels()
+        @see ScrollSections()
+
+        @since 2.9.5
+    */
+    bool ScrollSections(int sections);
+
     /**
         Get the direction in which ribbon panels are stacked within the page.