]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/scrolbar.h
use wxWANTS_CHARS to allow arrows to work inside the control
[wxWidgets.git] / interface / scrolbar.h
index 4ea95c9ad3e6617f900b0245787cb4a9e99b3fc5..ad9f31dac2ca299b4e061121fe5d83b72f4f4741 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        scrolbar.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        scrolbar.h
-// Purpose:     documentation for wxScrollBar class
+// Purpose:     interface of wxScrollBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -26,8 +26,7 @@
     @category{ctrl}
     @appearance{scrollbar.png}
 
     @category{ctrl}
     @appearance{scrollbar.png}
 
-    @seealso
-    @ref overview_scrollingoverview "Scrolling overview", @ref
+    @see @ref overview_scrollingoverview "Scrolling overview", @ref
     overview_eventhandlingoverview, wxScrolledWindow
 */
 class wxScrollBar : public wxControl
     overview_eventhandlingoverview, wxScrolledWindow
 */
 class wxScrollBar : public wxControl
@@ -36,7 +35,7 @@ public:
     //@{
     /**
         Constructor, creating and showing a scrollbar.
     //@{
     /**
         Constructor, creating and showing a scrollbar.
-        
+
         @param parent
             Parent window. Must be non-@NULL.
         @param id
         @param parent
             Parent window. Must be non-@NULL.
         @param id
@@ -53,7 +52,7 @@ public:
             Window validator.
         @param name
             Window name.
             Window validator.
         @param name
             Window name.
-        
+
         @see Create(), wxValidator
     */
     wxScrollBar();
         @see Create(), wxValidator
     */
     wxScrollBar();
@@ -85,35 +84,35 @@ public:
         Returns the page size of the scrollbar. This is the number of scroll units
         that will be scrolled when the user pages up or down. Often it is the
         same as the thumb size.
         Returns the page size of the scrollbar. This is the number of scroll units
         that will be scrolled when the user pages up or down. Often it is the
         same as the thumb size.
-        
+
         @see SetScrollbar()
     */
     int GetPageSize() const;
 
     /**
         Returns the length of the scrollbar.
         @see SetScrollbar()
     */
     int GetPageSize() const;
 
     /**
         Returns the length of the scrollbar.
-        
+
         @see SetScrollbar()
     */
     int GetRange() const;
 
     /**
         Returns the current position of the scrollbar thumb.
         @see SetScrollbar()
     */
     int GetRange() const;
 
     /**
         Returns the current position of the scrollbar thumb.
-        
+
         @see SetThumbPosition()
     */
     int GetThumbPosition() const;
 
     /**
         Returns the thumb or 'view' size.
         @see SetThumbPosition()
     */
     int GetThumbPosition() const;
 
     /**
         Returns the thumb or 'view' size.
-        
+
         @see SetScrollbar()
     */
     int GetThumbSize() const;
 
     /**
         Sets the scrollbar properties.
         @see SetScrollbar()
     */
     int GetThumbSize() const;
 
     /**
         Sets the scrollbar properties.
-        
+
         @param position
             The position of the scrollbar in scroll units.
         @param thumbSize
         @param position
             The position of the scrollbar in scroll units.
         @param thumbSize
@@ -127,7 +126,7 @@ public:
             the thumb size.
         @param refresh
             @true to redraw the scrollbar, @false otherwise.
             the thumb size.
         @param refresh
             @true to redraw the scrollbar, @false otherwise.
-        
+
         @remarks Let's say you wish to display 50 lines of text, using the same
                  font. The window is sized so that you can only see 16
                  lines at a time.
         @remarks Let's say you wish to display 50 lines of text, using the same
                  font. The window is sized so that you can only see 16
                  lines at a time.
@@ -138,11 +137,12 @@ public:
 
     /**
         Sets the position of the scrollbar.
 
     /**
         Sets the position of the scrollbar.
-        
+
         @param viewStart
             The position of the scrollbar thumb.
         @param viewStart
             The position of the scrollbar thumb.
-        
+
         @see GetThumbPosition()
     */
     void SetThumbPosition(int viewStart);
 };
         @see GetThumbPosition()
     */
     void SetThumbPosition(int viewStart);
 };
+