Clarify docs about wxSizer::SetSizeHints().

[wxWidgets.git] / docs / latex / wx / slider.tex

diff --git a/docs/latex/wx/slider.tex b/docs/latex/wx/slider.tex
index 672327701251290eec2dffd59e018d2efc9cbf84..898f67acd64b16f5326a74f3a035bcc2e6bc016c 100644 (file)
--- a/docs/latex/wx/slider.tex
+++ b/docs/latex/wx/slider.tex
@@ -3,8 +3,7 @@
 A slider is a control with a handle which can be pulled
 back and forth to change the value.
 
-In Windows versions below Windows 95, a scrollbar is used to simulate the slider. In Windows 95,
-the track bar control is used.
+On Windows, the track bar control is used.
 
 Slider events are handled in the same way as a scrollbar.
 
@@ -23,15 +22,16 @@ Slider events are handled in the same way as a scrollbar.
 
 \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.
-(NB: only displays the current value label under wxGTK)}
-\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\_SELRANGE}}{Allows the user to select a range on the slider. Windows 95 only.}
+\twocolitem{\windowstyle{wxSL\_LABELS}}{Displays minimum, maximum and value labels.}
+\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}
 
 See also \helpref{window styles overview}{windowstyles}.
@@ -228,37 +228,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}}
@@ -287,6 +256,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}}
@@ -343,6 +322,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}}