[ 1936700 ] wxCAL_SHOW_WEEK_NUMBERS, slightly modified

[wxWidgets.git] / interface / scrolbar.h

diff --git a/interface/scrolbar.h b/interface/scrolbar.h
index bb043a7685324da7e0fbfa9efb3a77f0cd637a26..6f097a8a987b7b0bb84da680a63b432ca078eca3 100644 (file)
--- a/interface/scrolbar.h
+++ b/interface/scrolbar.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        scrolbar.h
-// Purpose:     documentation for wxScrollBar class
+// Purpose:     interface of wxScrollBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -16,19 +16,17 @@
     events are received.
 
     @beginStyleTable
-    @style{wxSB_HORIZONTAL}:
+    @style{wxSB_HORIZONTAL}
            Specifies a horizontal scrollbar.
-    @style{wxSB_VERTICAL}:
+    @style{wxSB_VERTICAL}
            Specifies a vertical scrollbar.
     @endStyleTable
 
     @library{wxcore}
     @category{ctrl}
-    @appearance{scrollbar.png}
+    <!-- @appearance{scrollbar.png} -->
 
-    @seealso
-    @ref overview_scrollingoverview "Scrolling overview", @ref
-    overview_eventhandlingoverview "Event handling overview", wxScrolledWindow
+    @see @ref overview_scrolling, @ref overview_eventhandling, wxScrolled
 */
 class wxScrollBar : public wxControl
 {
@@ -36,31 +34,25 @@ public:
     //@{
     /**
         Constructor, creating and showing a scrollbar.
-        
+
         @param parent
-        Parent window. Must be non-@NULL.
-        
+            Parent window. Must be non-@NULL.
         @param id
-        Window identifier. The value wxID_ANY indicates a default value.
-        
+            Window identifier. The value wxID_ANY indicates a default value.
         @param pos
-        Window position. If wxDefaultPosition is specified then a default position
-        is chosen.
-        
+            Window position. If wxDefaultPosition is specified then a default
+        position is chosen.
         @param size
-        Window size. If wxDefaultSize is specified then a default size is
-        chosen.
-        
+            Window size. If wxDefaultSize is specified then a default size
+        is chosen.
         @param style
-        Window style. See wxScrollBar.
-        
+            Window style. See wxScrollBar.
         @param validator
-        Window validator.
-        
+            Window validator.
         @param name
-        Window name.
-        
-        @sa Create(), wxValidator
+            Window name.
+
+        @see Create(), wxValidator
     */
     wxScrollBar();
     wxScrollBar(wxWindow* parent, wxWindowID id,
@@ -91,67 +83,65 @@ 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.
-        
-        @sa SetScrollbar()
+
+        @see SetScrollbar()
     */
-    int GetPageSize();
+    int GetPageSize() const;
 
     /**
         Returns the length of the scrollbar.
-        
-        @sa SetScrollbar()
+
+        @see SetScrollbar()
     */
-    int GetRange();
+    int GetRange() const;
 
     /**
         Returns the current position of the scrollbar thumb.
-        
-        @sa SetThumbPosition()
+
+        @see SetThumbPosition()
     */
-    int GetThumbPosition();
+    int GetThumbPosition() const;
 
     /**
         Returns the thumb or 'view' size.
-        
-        @sa SetScrollbar()
+
+        @see SetScrollbar()
     */
-    int GetThumbSize();
+    int GetThumbSize() const;
 
     /**
         Sets the scrollbar properties.
-        
+
         @param position
-        The position of the scrollbar in scroll units.
-        
+            The position of the scrollbar in scroll units.
         @param thumbSize
-        The size of the thumb, or visible portion of the scrollbar, in scroll units.
-        
+            The size of the thumb, or visible portion of the scrollbar, in scroll units.
         @param range
-        The maximum position of the scrollbar.
-        
+            The maximum position of the scrollbar.
         @param pageSize
-        The size of the page size in scroll units. This is the number of units
-        the scrollbar will scroll when it is paged up or down. Often it is the same as
-        the thumb size.
-        
+            The size of the page size in scroll units. This is the number of units
+            the scrollbar will scroll when it is paged up or down. Often it is the same
+        as
+            the thumb size.
         @param refresh
-        @true to redraw the scrollbar, @false otherwise.
-        
+            @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.
+                 font. The window is sized so that you can only see 16
+                 lines at a time.
     */
     virtual void SetScrollbar(int position, int thumbSize, int range,
                               int pageSize,
-                              bool refresh = @true);
+                              bool refresh = true);
 
     /**
         Sets the position of the scrollbar.
-        
+
         @param viewStart
-        The position of the scrollbar thumb.
-        
-        @sa GetThumbPosition()
+            The position of the scrollbar thumb.
+
+        @see GetThumbPosition()
     */
     void SetThumbPosition(int viewStart);
 };
+