X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/57ab6f2314860f6efd2d1339913c91a302020a8e..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/ribbon/page.h diff --git a/interface/wx/ribbon/page.h b/interface/wx/ribbon/page.h index 72348ee23a..c6e2845342 100644 --- 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 /////////////////////////////////////////////////////////////////////////////// @@ -148,6 +147,7 @@ public: @see GetMajorAxis() @see ScrollPixels() + @see ScrollSections() */ virtual bool ScrollLines(int lines); @@ -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.