]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/wx/slider.h
committing the slightly-modified patch by R.U.10 for documenting some public function...
[wxWidgets.git] / interface / wx / slider.h
index 18647f5a84b2c03b26d815340bc26d217683f7c2..6bb50161b83528ee40a604ed1fca12ec76e9d39b 100644 (file)
     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} -->
+    @appearance{slider.png}
 
     @see @ref overview_eventhandling, wxScrollBar
 */
@@ -132,6 +130,8 @@ public:
             Minimum slider position.
         @param maxValue
             Maximum slider position.
+        @param pos
+            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.
         @param style
@@ -145,11 +145,11 @@ public:
     */
     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 wxString& name = "slider");
+             const wxString& name = wxSliderNameStr);
 
     /**
         Destructor, destroying the slider.
@@ -159,14 +159,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();
 
@@ -174,13 +174,11 @@ public:
         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 wxString& name = "slider");
+                const wxString& name = wxSliderNameStr);
 
     /**
         Returns the line size.
@@ -213,7 +211,7 @@ public:
     /**
         Returns the selection end point.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see GetSelStart(), SetSelection()
     */
@@ -222,7 +220,7 @@ public:
     /**
         Returns the selection start point.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see GetSelEnd(), SetSelection()
     */
@@ -231,7 +229,7 @@ public:
     /**
         Returns the thumb length.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see SetThumbLength()
     */
@@ -240,7 +238,7 @@ public:
     /**
         Returns the tick frequency.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see SetTickFreq()
     */
@@ -289,7 +287,7 @@ public:
         @param endPos
             The selection end position.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see GetSelStart(), GetSelEnd()
     */
@@ -301,7 +299,7 @@ public:
         @param len
             The thumb length.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see GetThumbLength()
     */
@@ -313,7 +311,7 @@ public:
         @param tickPos
             The tick position.
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see SetTickFreq()
     */
@@ -328,7 +326,7 @@ public:
         @param pos
             Position. Must be greater than zero. @todo: what is this for?
 
-        @remarks Windows 95 only.
+        @onlyfor{wxmsw}
 
         @see GetTickFreq()
     */