X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/184686f6562c480cc129fb0cab8d229d10068c99..2861eaee452dfef7aeaca2685be663db4e07510e:/docs/latex/wx/slider.tex?ds=sidebyside diff --git a/docs/latex/wx/slider.tex b/docs/latex/wx/slider.tex index 86d051bed7..e785d3a28e 100644 --- a/docs/latex/wx/slider.tex +++ b/docs/latex/wx/slider.tex @@ -18,17 +18,22 @@ Slider events are handled in the same way as a scrollbar. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt -\twocolitem{\windowstyle{wxSL\_HORIZONTAL}}{Displays the slider horizontally.} +\twocolitem{\windowstyle{wxSL\_HORIZONTAL}}{Displays the slider horizontally (this is the default).} \twocolitem{\windowstyle{wxSL\_VERTICAL}}{Displays the slider vertically.} \twocolitem{\windowstyle{wxSL\_AUTOTICKS}}{Displays tick marks.} \twocolitem{\windowstyle{wxSL\_LABELS}}{Displays minimum, maximum and value labels.} -\twocolitem{\windowstyle{wxSL\_LEFT}}{Displays ticks on the left, if a vertical slider.} -\twocolitem{\windowstyle{wxSL\_RIGHT}}{Displays ticks on the right, if a vertical slider.} -\twocolitem{\windowstyle{wxSL\_TOP}}{Displays ticks on the top, if a horizontal slider.} +\twocolitem{\windowstyle{wxSL\_LEFT}}{Displays ticks on the left and forces the slider to be vertical.} +\twocolitem{\windowstyle{wxSL\_RIGHT}}{Displays ticks on the right and forces the slider to be vertical.} +\twocolitem{\windowstyle{wxSL\_TOP}}{Displays ticks on the top.} +\twocolitem{\windowstyle{wxSL\_BOTTOM}}{Displays ticks on the bottom (this is the default).} \twocolitem{\windowstyle{wxSL\_SELRANGE}}{Allows the user to select a range on the slider. Windows only.} \twocolitem{\windowstyle{wxSL\_INVERSE}}{Inverses the mininum and maximum endpoints on the slider. Not compatible with wxSL\_SELRANGE.} \end{twocollist} @@ -227,37 +232,6 @@ Gets the current slider value. \helpref{wxSlider::GetMin}{wxslidergetmin}, \helpref{wxSlider::GetMax}{wxslidergetmax},\rtfsp \helpref{wxSlider::SetValue}{wxslidersetvalue} -\membersection{wxSlider::SetRange}\label{wxslidersetrange} - -\func{void}{SetRange}{\param{int}{ minValue}, \param{int}{ maxValue}} - -Sets the minimum and maximum slider values. - -\wxheading{See also} - -\helpref{wxSlider::GetMin}{wxslidergetmin}, \helpref{wxSlider::GetMax}{wxslidergetmax} - -\membersection{wxSlider::SetTickFreq}\label{wxslidersettickfreq} - -\func{void}{SetTickFreq}{\param{int }{n}, \param{int }{pos}} - -Sets the tick mark frequency and position. - -\wxheading{Parameters} - -\docparam{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.} - -\docparam{pos}{Position. Must be greater than zero. TODO: what is this for?} - -\wxheading{Remarks} - -Windows 95 only. - -\wxheading{See also} - -\helpref{wxSlider::GetTickFreq}{wxslidergettickfreq} - \membersection{wxSlider::SetLineSize}\label{wxslidersetlinesize} \func{void}{SetLineSize}{\param{int }{lineSize}} @@ -286,6 +260,16 @@ Sets the page size for the slider. \helpref{wxSlider::GetPageSize}{wxslidergetpagesize} +\membersection{wxSlider::SetRange}\label{wxslidersetrange} + +\func{void}{SetRange}{\param{int}{ minValue}, \param{int}{ maxValue}} + +Sets the minimum and maximum slider values. + +\wxheading{See also} + +\helpref{wxSlider::GetMin}{wxslidergetmin}, \helpref{wxSlider::GetMax}{wxslidergetmax} + \membersection{wxSlider::SetSelection}\label{wxslidersetselection} \func{void}{SetSelection}{\param{int }{startPos}, \param{int }{endPos}} @@ -342,6 +326,27 @@ Windows 95 only. \helpref{wxSlider::SetTickFreq}{wxslidersettickfreq} +\membersection{wxSlider::SetTickFreq}\label{wxslidersettickfreq} + +\func{void}{SetTickFreq}{\param{int }{n}, \param{int }{pos}} + +Sets the tick mark frequency and position. + +\wxheading{Parameters} + +\docparam{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.} + +\docparam{pos}{Position. Must be greater than zero. TODO: what is this for?} + +\wxheading{Remarks} + +Windows 95 only. + +\wxheading{See also} + +\helpref{wxSlider::GetTickFreq}{wxslidergettickfreq} + \membersection{wxSlider::SetValue}\label{wxslidersetvalue} \func{void}{SetValue}{\param{int}{ value}}