Use Cairo for wxGraphicsContext in wxX11.

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

diff --git a/interface/wx/slider.h b/interface/wx/slider.h
index 55f112fccb4f9e577b94b02f5c92fc67986d8560..2e1bec435df3b3abf317e4e894701a0cec49dd04 100644 (file)
--- a/interface/wx/slider.h
+++ b/interface/wx/slider.h
@@ -3,7 +3,7 @@
 // Purpose:     interface of wxSlider
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -22,9 +22,14 @@
     @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}
-           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}
@@ -40,7 +45,14 @@
            compatible with wxSL_SELRANGE.
     @endStyleTable
 
-    @beginEventTable{wxScrollEvent}
+    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,
@@ -103,13 +115,11 @@
     Please see the widgets sample ("Slider" page) to see the difference between
     EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
 
-    @todo are all strings "Windows 95 only" really up2date?
-
     @library{wxcore}
     @category{ctrl}
     @appearance{slider.png}
 
-    @see @ref overview_eventhandling, wxScrollBar
+    @see @ref overview_events, wxScrollBar
 */
 class wxSlider : public wxControl
 {
@@ -133,9 +143,11 @@ public:
         @param maxValue
             Maximum slider position.
         @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 wxSlider.
         @param validator
@@ -151,7 +163,7 @@ public:
              const wxSize& size = wxDefaultSize,
              long style = wxSL_HORIZONTAL,
              const wxValidator& validator = wxDefaultValidator,
-             const wxString& name = "slider");
+             const wxString& name = wxSliderNameStr);
 
     /**
         Destructor, destroying the slider.
@@ -161,14 +173,14 @@ public:
     /**
         Clears the selection, for a slider with the @b wxSL_SELRANGE style.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
     */
     virtual void ClearSel();
 
     /**
         Clears the ticks.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
     */
     virtual void ClearTicks();
 
@@ -213,7 +225,7 @@ public:
     /**
         Returns the selection end point.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see GetSelStart(), SetSelection()
     */
@@ -222,7 +234,7 @@ public:
     /**
         Returns the selection start point.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see GetSelEnd(), SetSelection()
     */
@@ -231,7 +243,7 @@ public:
     /**
         Returns the thumb length.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see SetThumbLength()
     */
@@ -240,7 +252,7 @@ public:
     /**
         Returns the tick frequency.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see SetTickFreq()
     */
@@ -289,7 +301,7 @@ public:
         @param endPos
             The selection end position.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see GetSelStart(), GetSelEnd()
     */
@@ -301,7 +313,7 @@ public:
         @param len
             The thumb length.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see GetThumbLength()
     */
@@ -313,7 +325,7 @@ public:
         @param tickPos
             The tick position.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see SetTickFreq()
     */
@@ -328,7 +340,7 @@ public:
         @param pos
             Position. Must be greater than zero. @todo: what is this for?
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see GetTickFreq()
     */