/////////////////////////////////////////////////////////////////////////////
// Name: slider.h
-// Purpose: documentation for wxSlider class
+// Purpose: interface of wxSlider
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@category{ctrl}
@appearance{slider.png}
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview", wxScrollBar
+ @see @ref overview_eventhandlingoverview, wxScrollBar
*/
class wxSlider : public wxControl
{
//@{
/**
Constructor, creating and showing a slider.
-
+
@param parent
- Parent window. Must not be @NULL.
-
+ Parent window. Must not be @NULL.
@param id
- Window identifier. The value wxID_ANY indicates a default value.
-
+ Window identifier. The value wxID_ANY indicates a default value.
@param value
- Initial position for the slider.
-
+ Initial position for the slider.
@param minValue
- Minimum slider position.
-
+ Minimum slider position.
@param maxValue
- Maximum slider position.
-
+ Maximum slider position.
@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.
-
+ Window style. See wxSlider.
@param validator
- Window validator.
-
+ Window validator.
@param name
- Window name.
-
- @sa Create(), wxValidator
+ Window name.
+
+ @see Create(), wxValidator
*/
wxSlider();
wxSlider(wxWindow* parent, wxWindowID id, int value,
/**
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 ClearTicks();
/**
Returns the line size.
-
- @sa SetLineSize()
+
+ @see SetLineSize()
*/
- int GetLineSize();
+ int GetLineSize() const;
/**
Gets the maximum slider value.
-
- @sa GetMin(), SetRange()
+
+ @see GetMin(), SetRange()
*/
- int GetMax();
+ int GetMax() const;
/**
Gets the minimum slider value.
-
- @sa GetMin(), SetRange()
+
+ @see GetMin(), SetRange()
*/
- int GetMin();
+ int GetMin() const;
/**
Returns the page size.
-
- @sa SetPageSize()
+
+ @see SetPageSize()
*/
- int GetPageSize();
+ int GetPageSize() const;
/**
Returns the selection end point.
-
+
@remarks Windows 95 only.
-
- @sa GetSelStart(), SetSelection()
+
+ @see GetSelStart(), SetSelection()
*/
- int GetSelEnd();
+ int GetSelEnd() const;
/**
Returns the selection start point.
-
+
@remarks Windows 95 only.
-
- @sa GetSelEnd(), SetSelection()
+
+ @see GetSelEnd(), SetSelection()
*/
- int GetSelStart();
+ int GetSelStart() const;
/**
Returns the thumb length.
-
+
@remarks Windows 95 only.
-
- @sa SetThumbLength()
+
+ @see SetThumbLength()
*/
- int GetThumbLength();
+ int GetThumbLength() const;
/**
Returns the tick frequency.
-
+
@remarks Windows 95 only.
-
- @sa SetTickFreq()
+
+ @see SetTickFreq()
*/
- int GetTickFreq();
+ int GetTickFreq() const;
/**
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.
-
+
@param lineSize
- The number of steps the slider moves when the user moves it up or down a line.
-
- @sa GetLineSize()
+ 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.
-
+
@param pageSize
- The number of steps the slider moves when the user pages up or down.
-
- @sa GetPageSize()
+ 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.
-
- @sa GetMin(), GetMax()
+
+ @see GetMin(), GetMax()
*/
void SetRange(int minValue, int maxValue);
/**
Sets the selection.
-
+
@param startPos
- The selection start position.
-
+ The selection start position.
@param endPos
- The selection end position.
-
+ The selection end position.
+
@remarks Windows 95 only.
-
- @sa GetSelStart(), GetSelEnd()
+
+ @see GetSelStart(), GetSelEnd()
*/
void SetSelection(int startPos, int endPos);
/**
Sets the slider thumb length.
-
+
@param len
- The thumb length.
-
+ The thumb length.
+
@remarks Windows 95 only.
-
- @sa GetThumbLength()
+
+ @see GetThumbLength()
*/
void SetThumbLength(int len);
/**
Sets a tick position.
-
+
@param tickPos
- The tick position.
-
+ The tick position.
+
@remarks Windows 95 only.
-
- @sa SetTickFreq()
+
+ @see SetTickFreq()
*/
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
+ Frequency. For example, if the frequency is set to two, a tick mark is
displayed for
- every other increment in the slider's range.
-
+ every other increment in the slider's range.
@param pos
- Position. Must be greater than zero. TODO: what is this for?
-
+ Position. Must be greater than zero. TODO: what is this for?
+
@remarks Windows 95 only.
-
- @sa GetTickFreq()
+
+ @see GetTickFreq()
*/
void SetTickFreq(int n, int pos);
/**
Sets the slider position.
-
+
@param value
- The slider position.
+ The slider position.
*/
void SetValue(int value);
};
+
projects / wxWidgets.git / blobdiff