mac paths updated

[wxWidgets.git] / interface / slider.h

diff --git a/interface/slider.h b/interface/slider.h
index 74df3737ff969dbbe15b474d77b26be2d212c478..5d20acb9fc373b31ab1b79fa746b75df22cc5638 100644 (file)
--- a/interface/slider.h
+++ b/interface/slider.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        slider.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        slider.h

-// Purpose:     documentation for wxSlider class
+// Purpose:     interface of wxSlider

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -9,91 +9,84 @@
 /**
     @class wxSlider
     @wxheader{slider.h}
 /**
     @class wxSlider
     @wxheader{slider.h}

-    
+

     A slider is a control with a handle which can be pulled
     back and forth to change the value.
     A slider is a control with a handle which can be pulled
     back and forth to change the value.

-    
+

     On Windows, the track bar control is used.
     On Windows, the track bar control is used.

-    
+

     Slider events are handled in the same way as a scrollbar.
     Slider events are handled in the same way as a scrollbar.

-    
+

     @beginStyleTable
     @beginStyleTable

-    @style{wxSL_HORIZONTAL}:
+    @style{wxSL_HORIZONTAL}

            Displays the slider horizontally (this is the default).
            Displays the slider horizontally (this is the default).

-    @style{wxSL_VERTICAL}:
+    @style{wxSL_VERTICAL}

            Displays the slider vertically.
            Displays the slider vertically.

-    @style{wxSL_AUTOTICKS}:
+    @style{wxSL_AUTOTICKS}

            Displays tick marks.
            Displays tick marks.

-    @style{wxSL_LABELS}:
+    @style{wxSL_LABELS}

            Displays minimum, maximum and value labels.
            Displays minimum, maximum and value labels.

-    @style{wxSL_LEFT}:
+    @style{wxSL_LEFT}

            Displays ticks on the left and forces the slider to be vertical.
            Displays ticks on the left and forces the slider to be vertical.

-    @style{wxSL_RIGHT}:
+    @style{wxSL_RIGHT}

            Displays ticks on the right and forces the slider to be vertical.
            Displays ticks on the right and forces the slider to be vertical.

-    @style{wxSL_TOP}:
+    @style{wxSL_TOP}

            Displays ticks on the top.
            Displays ticks on the top.

-    @style{wxSL_BOTTOM}:
+    @style{wxSL_BOTTOM}

            Displays ticks on the bottom (this is the default).
            Displays ticks on the bottom (this is the default).

-    @style{wxSL_SELRANGE}:
+    @style{wxSL_SELRANGE}

            Allows the user to select a range on the slider. Windows only.
            Allows the user to select a range on the slider. Windows only.

-    @style{wxSL_INVERSE}:
+    @style{wxSL_INVERSE}

            Inverses the mininum and maximum endpoints on the slider. Not
            compatible with wxSL_SELRANGE.
     @endStyleTable
            Inverses the mininum and maximum endpoints on the slider. Not
            compatible with wxSL_SELRANGE.
     @endStyleTable

-    
+

     @library{wxcore}
     @category{ctrl}
     @library{wxcore}
     @category{ctrl}

-    @appearance{slider.png}
-    
-    @seealso
-    @ref overview_eventhandlingoverview "Event handling overview", wxScrollBar
+    <!-- @appearance{slider.png} -->
+
+    @see @ref overview_eventhandlingoverview, wxScrollBar

 */
 class wxSlider : public wxControl
 {
 public:
 */
 class wxSlider : public wxControl
 {
 public:

-    //@{

     /**
     /**

-        Constructor, creating and showing a slider.
-        
-        @param parent 
-        Parent window. Must not be @NULL.
-        
-        @param id 
-        Window identifier. The value wxID_ANY indicates a default value.
-        
-        @param value 
-        Initial position for the slider.
-        
-        @param minValue 
-        Minimum slider position.
-        
-        @param maxValue 
-        Maximum slider position.
-        
-        @param size 
-        Window size. If wxDefaultSize is specified then a default size is
-        chosen.
-        
-        @param style 
-        Window style. See wxSlider.
-        
-        @param validator 
-        Window validator.
-        
-        @param name 
-        Window name.
-        
-        @sa Create(), wxValidator
+       Default constructor

     */
     wxSlider();
     */
     wxSlider();

-        wxSlider(wxWindow* parent, wxWindowID id, int value,
-                 int minValue, int maxValue,
-                 const wxPoint& point = wxDefaultPosition,
-                 const wxSize& size = wxDefaultSize,
-                 long style = wxSL_HORIZONTAL,
-                 const wxValidator& validator = wxDefaultValidator,
-                 const wxString& name = "slider");
-    //@}
+    
+    /**
+        Constructor, creating and showing a slider.
+
+        @param parent
+            Parent window. Must not be @NULL.
+        @param id
+            Window identifier. The value wxID_ANY indicates a default value.
+        @param value
+            Initial position for the slider.
+        @param minValue
+            Minimum slider position.
+        @param maxValue
+            Maximum slider position.
+        @param size
+            Window size. If wxDefaultSize is specified then a default size
+        is chosen.
+        @param style
+            Window style. See wxSlider.
+        @param validator
+            Window validator.
+        @param name
+            Window name.
+
+        @see Create(), wxValidator
+    */
+    wxSlider(wxWindow* parent, wxWindowID id, int value,
+             int minValue, int maxValue,
+             const wxPoint& point = wxDefaultPosition,
+             const wxSize& size = wxDefaultSize,
+             long style = wxSL_HORIZONTAL,
+             const wxValidator& validator = wxDefaultValidator,
+             const wxString& name = "slider");

 
     /**
         Destructor, destroying the slider.
 
     /**
         Destructor, destroying the slider.


@@ -102,14 +95,14 @@ public:
 
     /**
         Clears the selection, for a slider with the @b wxSL_SELRANGE style.
 
     /**
         Clears the selection, for a slider with the @b wxSL_SELRANGE style.

-        
+

         @remarks Windows 95 only.
     */
     void ClearSel();
 
     /**
         Clears the ticks.
         @remarks Windows 95 only.
     */
     void ClearSel();
 
     /**
         Clears the ticks.

-        
+

         @remarks Windows 95 only.
     */
     void ClearTicks();
         @remarks Windows 95 only.
     */
     void ClearTicks();


@@ -128,163 +121,163 @@ public:
 
     /**
         Returns the line size.
 
     /**
         Returns the line size.

-        
-        @sa SetLineSize()
+
+        @see SetLineSize()

     */
     */

-    int GetLineSize();
+    int GetLineSize() const;

 
     /**
         Gets the maximum slider value.
 
     /**
         Gets the maximum slider value.

-        
-        @sa GetMin(), SetRange()
+
+        @see GetMin(), SetRange()

     */
     */

-    int GetMax();
+    int GetMax() const;

 
     /**
         Gets the minimum slider value.
 
     /**
         Gets the minimum slider value.

-        
-        @sa GetMin(), SetRange()
+
+        @see GetMin(), SetRange()

     */
     */

-    int GetMin();
+    int GetMin() const;

 
     /**
         Returns the page size.
 
     /**
         Returns the page size.

-        
-        @sa SetPageSize()
+
+        @see SetPageSize()

     */
     */

-    int GetPageSize();
+    int GetPageSize() const;

 
     /**
         Returns the selection end point.
 
     /**
         Returns the selection end point.

-        
+

         @remarks Windows 95 only.
         @remarks Windows 95 only.

-        
-        @sa GetSelStart(), SetSelection()
+
+        @see GetSelStart(), SetSelection()

     */
     */

-    int GetSelEnd();
+    int GetSelEnd() const;

 
     /**
         Returns the selection start point.
 
     /**
         Returns the selection start point.

-        
+

         @remarks Windows 95 only.
         @remarks Windows 95 only.

-        
-        @sa GetSelEnd(), SetSelection()
+
+        @see GetSelEnd(), SetSelection()

     */
     */

-    int GetSelStart();
+    int GetSelStart() const;

 
     /**
         Returns the thumb length.
 
     /**
         Returns the thumb length.

-        
+

         @remarks Windows 95 only.
         @remarks Windows 95 only.

-        
-        @sa SetThumbLength()
+
+        @see SetThumbLength()

     */
     */

-    int GetThumbLength();
+    int GetThumbLength() const;

 
     /**
         Returns the tick frequency.
 
     /**
         Returns the tick frequency.

-        
+

         @remarks Windows 95 only.
         @remarks Windows 95 only.

-        
-        @sa SetTickFreq()
+
+        @see SetTickFreq()

     */
     */

-    int GetTickFreq();
+    int GetTickFreq() const;

 
     /**
         Gets the current slider value.
 
     /**
         Gets the current slider value.

-        
-        @sa GetMin(), GetMax(), SetValue()
+
+        @see GetMin(), GetMax(), SetValue()

     */
     */

-    int GetValue();
+    int GetValue() const;

 
     /**
         Sets the line size for the slider.
 
     /**
         Sets the line size for the slider.

-        
-        @param lineSize 
-        The number of steps the slider moves when the user moves it up or down a line.
-        
-        @sa GetLineSize()
+
+        @param lineSize
+            The number of steps the slider moves when the user moves it up or down a
+        line.
+
+        @see GetLineSize()

     */
     void SetLineSize(int lineSize);
 
     /**
         Sets the page size for the slider.
     */
     void SetLineSize(int lineSize);
 
     /**
         Sets the page size for the slider.

-        
-        @param pageSize 
-        The number of steps the slider moves when the user pages up or down.
-        
-        @sa GetPageSize()
+
+        @param pageSize
+            The number of steps the slider moves when the user pages up or down.
+
+        @see GetPageSize()

     */
     void SetPageSize(int pageSize);
 
     /**
         Sets the minimum and maximum slider values.
     */
     void SetPageSize(int pageSize);
 
     /**
         Sets the minimum and maximum slider values.

-        
-        @sa GetMin(), GetMax()
+
+        @see GetMin(), GetMax()

     */
     void SetRange(int minValue, int maxValue);
 
     /**
         Sets the selection.
     */
     void SetRange(int minValue, int maxValue);
 
     /**
         Sets the selection.

-        
-        @param startPos 
-        The selection start position.
-        
-        @param endPos 
-        The selection end position.
-        
+
+        @param startPos
+            The selection start position.
+        @param endPos
+            The selection end position.
+

         @remarks Windows 95 only.
         @remarks Windows 95 only.

-        
-        @sa GetSelStart(), GetSelEnd()
+
+        @see GetSelStart(), GetSelEnd()

     */
     void SetSelection(int startPos, int endPos);
 
     /**
         Sets the slider thumb length.
     */
     void SetSelection(int startPos, int endPos);
 
     /**
         Sets the slider thumb length.

-        
-        @param len 
-        The thumb length.
-        
+
+        @param len
+            The thumb length.
+

         @remarks Windows 95 only.
         @remarks Windows 95 only.

-        
-        @sa GetThumbLength()
+
+        @see GetThumbLength()

     */
     void SetThumbLength(int len);
 
     /**
         Sets a tick position.
     */
     void SetThumbLength(int len);
 
     /**
         Sets a tick position.

-        
-        @param tickPos 
-        The tick position.
-        
+
+        @param tickPos
+            The tick position.
+

         @remarks Windows 95 only.
         @remarks Windows 95 only.

-        
-        @sa SetTickFreq()
+
+        @see SetTickFreq()

     */
     void SetTick(int tickPos);
 
     /**
         Sets the tick mark frequency and position.
     */
     void SetTick(int tickPos);
 
     /**
         Sets the tick mark frequency and position.

-        
-        @param n 
-        Frequency. For example, if the frequency is set to two, a tick mark is
+
+        @param n
+            Frequency. For example, if the frequency is set to two, a tick mark is

         displayed for
         displayed for

-        every other increment in the slider's range.
-        
-        @param pos 
-        Position. Must be greater than zero. TODO: what is this for?
-        
+            every other increment in the slider's range.
+        @param pos
+            Position. Must be greater than zero. TODO: what is this for?
+

         @remarks Windows 95 only.
         @remarks Windows 95 only.

-        
-        @sa GetTickFreq()
+
+        @see GetTickFreq()

     */
     void SetTickFreq(int n, int pos);
 
     /**
         Sets the slider position.
     */
     void SetTickFreq(int n, int pos);
 
     /**
         Sets the slider position.

-        
-        @param value 
-        The slider position.
+
+        @param value
+            The slider position.

     */
     void SetValue(int value);
 };
     */
     void SetValue(int value);
 };

+