]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/scrolbar.tex
Deprecated wxSizer::Remove( wxWindow* ), s/Remove/Detach/ in most places.
[wxWidgets.git] / docs / latex / wx / scrolbar.tex
index 89526994ebc680f9b4e02344c5e4fd22fb7734e0..a9fba5aa2ac86bb379a7f2642ba9f5ad1e23459e 100644 (file)
@@ -12,6 +12,10 @@ events are received.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/scrolbar.h>
+
 \wxheading{Remarks}
 
 A scrollbar has the following main attributes: {\it range}, {\it thumb size}, {\it page size}, and {\it position}.
@@ -45,22 +49,7 @@ to the size of the window and the size of the data.
 
 See also \helpref{window styles overview}{windowstyles}.
 
-\wxheading{Event handling}
-
-To process input from a scrollbar, 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).}
-\end{twocollist}%
+\input scrolevt.inc
 
 \wxheading{See also}
 
@@ -141,15 +130,15 @@ same as the thumb size.
 
 \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar}
 
-\membersection{wxScrollBar::GetPosition}\label{wxscrollbargetposition}
+\membersection{wxScrollBar::GetThumbPosition}\label{wxscrollbargetthumbposition}
 
-\constfunc{int}{GetPosition}{\void}
+\constfunc{int}{GetThumbPosition}{\void}
 
-Returns the current position of the scrollbar.
+Returns the current position of the scrollbar thumb.
 
 \wxheading{See also}
 
-\helpref{wxScrollBar::SetPosition}{wxscrollbarsetposition}
+\helpref{wxScrollBar::SetThumbPosition}{wxscrollbarsetthumbposition}
 
 \membersection{wxScrollBar::GetThumbLength}\label{wxscrollbargetthumblength}
 
@@ -207,9 +196,9 @@ At present, this needs to be called {\it before} other set functions.
 \helpref{wxScrollBar::GetPageSize}{wxscrollbargetpagesize}
 \end{comment}
 
-\membersection{wxScrollBar::SetPosition}\label{wxscrollbarsetposition}
+\membersection{wxScrollBar::SetThumbPosition}\label{wxscrollbarsetthumbposition}
 
-\func{void}{SetPosition}{\param{int}{ viewStart}}
+\func{void}{SetThumbPosition}{\param{int}{ viewStart}}
 
 Sets the position of the scrollbar.
 
@@ -219,7 +208,7 @@ Sets the position of the scrollbar.
 
 \wxheading{See also}
 
-\helpref{wxScrollBar::GetPosition}{wxscrollbargetposition}
+\helpref{wxScrollBar::GetThumbPosition}{wxscrollbargetthumbposition}
 
 \membersection{wxScrollBar::SetScrollbar}\label{wxscrollbarsetscrollbar}
 
@@ -270,7 +259,7 @@ When defining your own scrollbar behaviour, you will always need to recalculate
 the scrollbar settings when the window size changes. You could therefore put your
 scrollbar calculations and SetScrollbar
 call into a function named AdjustScrollbars, which can be called initially and also
-from a \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function.
+from a \helpref{wxSizeEvent}{wxsizeevent} event handler function.
 
 \wxheading{See also}