documented VFS handlers

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

diff --git a/docs/latex/wx/slider.tex b/docs/latex/wx/slider.tex
index e42ae9b61938c5acc57ee86f3a6ceae7d1176c37..7d0d39105025aec301c2e0b9ec02b7bf9726a025 100644 (file)
--- a/docs/latex/wx/slider.tex
+++ b/docs/latex/wx/slider.tex
@@ -15,6 +15,10 @@ Slider events are handled in the same way as a scrollbar.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/slider.h>
+
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
@@ -22,7 +26,8 @@ Slider events are handled in the same way as a scrollbar.
 \twocolitem{\windowstyle{wxSL\_HORIZONTAL}}{Displays the slider horizontally.}
 \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\_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.}
@@ -31,6 +36,25 @@ Slider events are handled in the same way as a scrollbar.
 
 See also \helpref{window styles overview}{windowstyles}.
 
+\wxheading{Event handling}
+
+To process input from a slider, use one of these event handler macros to direct input to member
+functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument:
+
+\twocolwidtha{7cm}
+\begin{twocollist}
+\twocolitem{{\bf EVT\_COMMAND\_SCROLL(id, func)}}{Catch all scroll commands.}
+\twocolitem{{\bf EVT\_COMMAND\_TOP(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
+\twocolitem{{\bf EVT\_COMMAND\_BOTTOM(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
+\twocolitem{{\bf EVT\_COMMAND\_LINEUP(id, func)}}{Catch a line up command.}
+\twocolitem{{\bf EVT\_COMMAND\_LINEDOWN(id, func)}}{Catch a line down command.}
+\twocolitem{{\bf EVT\_COMMAND\_PAGEUP(id, func)}}{Catch a page up command.}
+\twocolitem{{\bf EVT\_COMMAND\_PAGEDOWN(id, func)}}{Catch a page down command.}
+\twocolitem{{\bf EVT\_COMMAND\_THUMBTRACK(id, func)}}{Catch a thumbtrack command (continuous movement of the scroll thumb).}
+\twocolitem{{\bf EVT\_SLIDER(id, func)}}{Process a wxEVT\_COMMAND\_SLIDER\_UPDATED event,
+when the slider is moved. Though provided for backward compatibility, this is obsolete.}
+\end{twocollist}%
+
 \wxheading{See also}
 
 \helpref{Event handling overview}{eventhandlingoverview}, \helpref{wxScrollBar}{wxscrollbar}
@@ -43,10 +67,10 @@ See also \helpref{window styles overview}{windowstyles}.
 
 Default slider.
 
-\func{}{wxSlider}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const int }{value },\rtfsp
-\param{const int}{ minValue}, \param{const int}{ maxValue},\rtfsp
+\func{}{wxSlider}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{int }{value },\rtfsp
+\param{int}{ minValue}, \param{int}{ maxValue},\rtfsp
 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long}{ style = wxSL\_HORIZONTAL},\rtfsp
+\param{long}{ style = wxSL\_HORIZONTAL},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 \param{const wxString\& }{name = ``slider"}}
 
@@ -104,10 +128,10 @@ Windows 95 only.
 
 \membersection{wxSlider::Create}\label{wxslidercreate}
 
-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id}, \param{const int }{value },\rtfsp
-\param{const int}{ minValue}, \param{const int}{ maxValue},\rtfsp
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{int }{value },\rtfsp
+\param{int}{ minValue}, \param{int}{ maxValue},\rtfsp
 \param{const wxPoint\& }{point = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long}{ style = wxSL\_HORIZONTAL},\rtfsp
+\param{long}{ style = wxSL\_HORIZONTAL},\rtfsp
 \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
 \param{const wxString\& }{name = ``slider"}}
 
@@ -223,7 +247,7 @@ Gets the current slider value.
 
 \membersection{wxSlider::SetRange}\label{wxslidersetrange}
 
-\func{void}{SetRange}{\param{const int}{ minValue}, \param{const int}{ maxValue}}
+\func{void}{SetRange}{\param{int}{ minValue}, \param{int}{ maxValue}}
 
 Sets the minimum and maximum slider values.
 
@@ -233,7 +257,7 @@ Sets the minimum and maximum slider values.
 
 \membersection{wxSlider::SetTickFreq}\label{wxslidersettickfreq}
 
-\func{void}{SetTickFreq}{\param{const int }{n}, \param{const int }{pos}}
+\func{void}{SetTickFreq}{\param{int }{n}, \param{int }{pos}}
 
 Sets the tick mark frequency and position.
 
@@ -254,7 +278,7 @@ Windows 95 only.
 
 \membersection{wxSlider::SetLineSize}\label{wxslidersetlinesize}
 
-\func{void}{SetLineSize}{\param{const int }{lineSize}}
+\func{void}{SetLineSize}{\param{int }{lineSize}}
 
 Sets the line size for the slider.
 
@@ -268,7 +292,7 @@ Sets the line size for the slider.
 
 \membersection{wxSlider::SetPageSize}\label{wxslidersetpagesize}
 
-\func{void}{SetPageSize}{\param{const int }{pageSize}}
+\func{void}{SetPageSize}{\param{int }{pageSize}}
 
 Sets the page size for the slider.
 
@@ -282,7 +306,7 @@ Sets the page size for the slider.
 
 \membersection{wxSlider::SetSelection}\label{wxslidersetselection}
 
-\func{void}{SetSelection}{\param{const int }{startPos}, \param{const int }{endPos}}
+\func{void}{SetSelection}{\param{int }{startPos}, \param{int }{endPos}}
 
 Sets the selection.
 
@@ -302,7 +326,7 @@ Windows 95 only.
 
 \membersection{wxSlider::SetThumbLength}\label{wxslidersetthumblength}
 
-\func{void}{SetThumbLength}{\param{const int }{len}}
+\func{void}{SetThumbLength}{\param{int }{len}}
 
 Sets the slider thumb length.
 
@@ -320,7 +344,7 @@ Windows 95 only.
 
 \membersection{wxSlider::SetTick}\label{wxslidersettick}
 
-\func{void}{SetTick}{\param{const int}{ tickPos}}
+\func{void}{SetTick}{\param{int}{ tickPos}}
 
 Sets a tick position.
 
@@ -338,7 +362,7 @@ Windows 95 only.
 
 \membersection{wxSlider::SetValue}\label{wxslidersetvalue}
 
-\func{void}{SetValue}{\param{const int}{ value}}
+\func{void}{SetValue}{\param{int}{ value}}
 
 Sets the slider position.