X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/58d0deaac1af12c41b27de4c92dae023c2616b03..27d79a5027bee4f46e57c813d072422065cb1592:/docs/doxygen/overviews/scrolling.h diff --git a/docs/doxygen/overviews/scrolling.h b/docs/doxygen/overviews/scrolling.h index 1c1eb43164..a3a70f814c 100644 --- a/docs/doxygen/overviews/scrolling.h +++ b/docs/doxygen/overviews/scrolling.h @@ -3,17 +3,14 @@ // Purpose: topic overview // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// -/*! +/** -@page overview_scrolling Scrolling Overview +@page overview_scrolling Scrolled Windows -Classes: -@li wxWindow -@li wxScrolledWindow -@li wxScrollBar +@tableofcontents Scrollbars come in various guises in wxWidgets. All windows have the potential to show a vertical scrollbar and/or a horizontal scrollbar: it is a basic @@ -29,7 +26,7 @@ events. If you created a wxWindow object with scrollbars, and then clicked on the scrollbars, nothing at all would happen. This is deliberate, because the @e interpretation of scroll events varies from one window class to another. -wxScrolledWindow (formerly wxCanvas) is an example of a window that adds +::wxScrolledWindow (formerly wxCanvas) is an example of a window that adds functionality to make scrolling really work. It assumes that scrolling happens in consistent units, not different-sized jumps, and that page size is represented by the visible portion of the window. It is suited to drawing @@ -39,6 +36,8 @@ this, you would derive from wxWindow and implement scrolling yourself. wxGrid is an example of a class that implements its own scrolling, largely because columns and rows can vary in size. +@see wxScrollBar + @section overview_scrolling_model The Scrollbar Model @@ -95,4 +94,3 @@ AdjustScrollbars, which can be called initially and also from your wxSizeEvent handler function. */ -