]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/slider.tex
applied wxTR_HIDE_ROOT patch for wxMSW
[wxWidgets.git] / docs / latex / wx / slider.tex
index 18d1b11c038767b593ac107dc943c14200960834..7d0d39105025aec301c2e0b9ec02b7bf9726a025 100644 (file)
@@ -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}