X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a660d684eda27638bca0384b2058911a31c8e845..77c5eefb1f06a8956231d2cbe1526e4de526cac5:/docs/latex/wx/slider.tex?ds=sidebyside diff --git a/docs/latex/wx/slider.tex b/docs/latex/wx/slider.tex index e42ae9b619..968974c5eb 100644 --- a/docs/latex/wx/slider.tex +++ b/docs/latex/wx/slider.tex @@ -31,6 +31,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 +62,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 +123,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 +242,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 +252,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 +273,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 +287,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 +301,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 +321,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 +339,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 +357,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.