Use wxUIntPtr instead of wxClientData in wxDataViewListCtrl.

[wxWidgets.git] / interface / wx / slider.h

diff --git a/interface/wx/slider.h b/interface/wx/slider.h
index f1c8bc89b42fb7c5dd21ab6ffb3e98f58c8eeacd..36554a629da5fcdbe5db417616d17c9bc5e9ae6a 100644 (file)
--- a/interface/wx/slider.h
+++ b/interface/wx/slider.h
@@ -3,14 +3,31 @@
 // Purpose:     interface of wxSlider
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxSlider
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+
+#define wxSL_HORIZONTAL      wxHORIZONTAL /* 0x0004 */
+#define wxSL_VERTICAL        wxVERTICAL   /* 0x0008 */
+
+#define wxSL_TICKS           0x0010
+#define wxSL_AUTOTICKS       wxSL_TICKS // we don't support manual ticks
+#define wxSL_LEFT            0x0040
+#define wxSL_TOP             0x0080
+#define wxSL_RIGHT           0x0100
+#define wxSL_BOTTOM          0x0200
+#define wxSL_BOTH            0x0400
+#define wxSL_SELRANGE        0x0800
+#define wxSL_INVERSE         0x1000
+#define wxSL_MIN_MAX_LABELS  0x2000
+#define wxSL_VALUE_LABEL     0x4000
+#define wxSL_LABELS          (wxSL_MIN_MAX_LABELS|wxSL_VALUE_LABEL)
+

 /**
     @class wxSlider
 
 /**
     @class wxSlider
 

-    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.
 


@@ -22,9 +39,14 @@
     @style{wxSL_VERTICAL}
            Displays the slider vertically.
     @style{wxSL_AUTOTICKS}
     @style{wxSL_VERTICAL}
            Displays the slider vertically.
     @style{wxSL_AUTOTICKS}

-           Displays tick marks.
+           Displays tick marks. Windows only.
+    @style{wxSL_MIN_MAX_LABELS}
+           Displays minimum, maximum labels (new since wxWidgets 2.9.1).
+    @style{wxSL_VALUE_LABEL}
+           Displays value label (new since wxWidgets 2.9.1).

     @style{wxSL_LABELS}
     @style{wxSL_LABELS}

-           Displays minimum, maximum and value labels.
+           Displays minimum, maximum and value labels (same as wxSL_VALUE_LABEL
+           and wxSL_MIN_MAX_LABELS together).

     @style{wxSL_LEFT}
            Displays ticks on the left and forces the slider to be vertical.
     @style{wxSL_RIGHT}
     @style{wxSL_LEFT}
            Displays ticks on the left and forces the slider to be vertical.
     @style{wxSL_RIGHT}


@@ -36,15 +58,88 @@
     @style{wxSL_SELRANGE}
            Allows the user to select a range on the slider. Windows only.
     @style{wxSL_INVERSE}
     @style{wxSL_SELRANGE}
            Allows the user to select a range on the slider. Windows only.
     @style{wxSL_INVERSE}

-           Inverses the mininum and maximum endpoints on the slider. Not
+           Inverses the minimum and maximum endpoints on the slider. Not

            compatible with wxSL_SELRANGE.
     @endStyleTable
 
            compatible with wxSL_SELRANGE.
     @endStyleTable
 

+    Notice that @c wxSL_LEFT, @c wxSL_TOP, @c wxSL_RIGHT and @c wxSL_BOTTOM
+    specify the position of the slider ticks in MSW implementation and that the
+    slider labels, if any, are positioned on the opposite side. So, to have a
+    label on the left side of a vertical slider, @b wxSL_RIGHT must be used (or
+    none of these styles at all should be specified as left and top are default
+    positions for the vertical and horizontal sliders respectively).
+
+    @beginEventEmissionTable{wxScrollEvent}
+    You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
+    scroll events from controls, or EVT_SCROLL... macros without window IDs for
+    intercepting scroll events from the receiving window -- except for this,
+    the macros behave exactly the same.
+    @event{EVT_SCROLL(func)}
+        Process all scroll events.
+    @event{EVT_SCROLL_TOP(func)}
+        Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
+    @event{EVT_SCROLL_BOTTOM(func)}
+        Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
+    @event{EVT_SCROLL_LINEUP(func)}
+        Process @c wxEVT_SCROLL_LINEUP line up events.
+    @event{EVT_SCROLL_LINEDOWN(func)}
+        Process @c wxEVT_SCROLL_LINEDOWN line down events.
+    @event{EVT_SCROLL_PAGEUP(func)}
+        Process @c wxEVT_SCROLL_PAGEUP page up events.
+    @event{EVT_SCROLL_PAGEDOWN(func)}
+        Process @c wxEVT_SCROLL_PAGEDOWN page down events.
+    @event{EVT_SCROLL_THUMBTRACK(func)}
+        Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events
+        (frequent events sent as the user drags the thumbtrack).
+    @event{EVT_SCROLL_THUMBRELEASE(func)}
+        Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
+    @event{EVT_SCROLL_CHANGED(func)}
+        Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
+    @event{EVT_COMMAND_SCROLL(id, func)}
+        Process all scroll events.
+    @event{EVT_COMMAND_SCROLL_TOP(id, func)}
+        Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
+    @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
+        Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
+    @event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
+        Process @c wxEVT_SCROLL_LINEUP line up events.
+    @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
+        Process @c wxEVT_SCROLL_LINEDOWN line down events.
+    @event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
+        Process @c wxEVT_SCROLL_PAGEUP page up events.
+    @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
+        Process @c wxEVT_SCROLL_PAGEDOWN page down events.
+    @event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
+        Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events
+        (frequent events sent as the user drags the thumbtrack).
+    @event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
+        Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
+    @event{EVT_COMMAND_SCROLL_CHANGED(func)}
+        Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
+    @event{EVT_SLIDER(id, func)}
+        Process @c wxEVT_COMMAND_SLIDER_UPDATED which is generated after any
+        change of wxSlider position in addition to one of the events above.
+    @endEventTable
+
+    @section slider_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
+
+    The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the
+    thumb using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event
+    is also followed by an EVT_SCROLL_CHANGED event).
+
+    The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change
+    the thumb position, and when clicking next to the thumb
+    (In all these cases the EVT_SCROLL_THUMBRELEASE event does not happen).
+    In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving
+    has finished independently of the way it had started.
+    Please see the widgets sample ("Slider" page) to see the difference between
+    EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
+

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

-    <!-- @appearance{slider.png} -->
+    @appearance{slider.png}

 
 

-    @see @ref overview_eventhandling, wxScrollBar
+    @see @ref overview_events, wxScrollBar

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


@@ -67,9 +162,12 @@ public:
             Minimum slider position.
         @param maxValue
             Maximum slider position.
             Minimum slider position.
         @param maxValue
             Maximum slider position.

+        @param pos
+            Window position. 
+            If ::wxDefaultPosition is specified then a default position is chosen.

         @param size
         @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 wxSlider.
         @param validator
         @param style
             Window style. See wxSlider.
         @param validator


@@ -81,11 +179,11 @@ public:
     */
     wxSlider(wxWindow* parent, wxWindowID id, int value,
              int minValue, int maxValue,
     */
     wxSlider(wxWindow* parent, wxWindowID id, int value,
              int minValue, int maxValue,

-             const wxPoint& point = wxDefaultPosition,
+             const wxPoint& pos = wxDefaultPosition,

              const wxSize& size = wxDefaultSize,
              long style = wxSL_HORIZONTAL,
              const wxValidator& validator = wxDefaultValidator,
              const wxSize& size = wxDefaultSize,
              long style = wxSL_HORIZONTAL,
              const wxValidator& validator = wxDefaultValidator,

-             const wxString& name = "slider");
+             const wxString& name = wxSliderNameStr);

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


@@ -95,28 +193,26 @@ 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.
+        @onlyfor{wxmsw}

     */
     virtual void ClearSel();
 
     /**
         Clears the ticks.
 
     */
     virtual void ClearSel();
 
     /**
         Clears the ticks.
 

-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}

     */
     virtual void ClearTicks();
 
     /**
     */
     virtual void ClearTicks();
 
     /**

-        Used for two-step slider construction. See wxSlider()
-        for further details.
+        Used for two-step slider construction.
+        See wxSlider() for further details.

     */
     */

-    bool Create(wxWindow* parent, wxWindowID id, int value,
-                int minValue, int maxValue,
-                const wxPoint& point = wxDefaultPosition,
-                const wxSize& size = wxDefaultSize,
-                long style = wxSL_HORIZONTAL,
+    bool Create(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 wxValidator& validator = wxDefaultValidator,

-                const wxString& name = "slider");
+                const wxString& name = wxSliderNameStr);

 
     /**
         Returns the line size.
 
     /**
         Returns the line size.


@@ -149,7 +245,7 @@ public:
     /**
         Returns the selection end point.
 
     /**
         Returns the selection end point.
 

-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}

 
         @see GetSelStart(), SetSelection()
     */
 
         @see GetSelStart(), SetSelection()
     */


@@ -158,7 +254,7 @@ public:
     /**
         Returns the selection start point.
 
     /**
         Returns the selection start point.
 

-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}

 
         @see GetSelEnd(), SetSelection()
     */
 
         @see GetSelEnd(), SetSelection()
     */


@@ -167,7 +263,7 @@ public:
     /**
         Returns the thumb length.
 
     /**
         Returns the thumb length.
 

-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}

 
         @see SetThumbLength()
     */
 
         @see SetThumbLength()
     */


@@ -176,7 +272,7 @@ public:
     /**
         Returns the tick frequency.
 
     /**
         Returns the tick frequency.
 

-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}

 
         @see SetTickFreq()
     */
 
         @see SetTickFreq()
     */


@@ -193,8 +289,8 @@ public:
         Sets the line size for the slider.
 
         @param lineSize
         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.
+            The number of steps the slider moves when the user moves it up
+            or down a line.

 
         @see GetLineSize()
     */
 
         @see GetLineSize()
     */


@@ -225,7 +321,7 @@ public:
         @param endPos
             The selection end position.
 
         @param endPos
             The selection end position.
 

-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}

 
         @see GetSelStart(), GetSelEnd()
     */
 
         @see GetSelStart(), GetSelEnd()
     */


@@ -237,7 +333,7 @@ public:
         @param len
             The thumb length.
 
         @param len
             The thumb length.
 

-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}

 
         @see GetThumbLength()
     */
 
         @see GetThumbLength()
     */


@@ -249,7 +345,7 @@ public:
         @param tickPos
             The tick position.
 
         @param tickPos
             The tick position.
 

-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}

 
         @see SetTickFreq()
     */
 
         @see SetTickFreq()
     */


@@ -260,16 +356,13 @@ public:
 
         @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
-            every other increment in the slider's range.
-        @param pos
-            Position. Must be greater than zero. TODO: what is this for?
+            displayed for every other increment in the slider's range.

 
 

-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}

 
         @see GetTickFreq()
     */
 
         @see GetTickFreq()
     */

-    virtual void SetTickFreq(int n, int pos);
+    virtual void SetTickFreq(int n);

 
     /**
         Sets the slider position.
 
     /**
         Sets the slider position.