1. made ScrollLines/Pages return bool indicating if we scrolled till the

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

diff --git a/docs/latex/wx/scrolbar.tex b/docs/latex/wx/scrolbar.tex
index 657fb9c811d68c73b92b650c905bae582989dd3d..2c35236e84563e8a5dd041e7929c9cd489eafb42 100644 (file)
--- a/docs/latex/wx/scrolbar.tex
+++ b/docs/latex/wx/scrolbar.tex
@@ -12,15 +12,9 @@ events are received.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
-\wxheading{Window styles}
-
-\twocolwidtha{5cm}
-\begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxSB\_HORIZONTAL}}{Specifies a horizontal scrollbar.}
-\twocolitem{\windowstyle{wxSB\_VERTICAL}}{Specifies a vertical scrollbar.}
-\end{twocollist}
+\wxheading{Include files}
 
-See also \helpref{window styles overview}{windowstyles}.
+<wx/scrolbar.h>
 
 \wxheading{Remarks}
 
@@ -45,6 +39,16 @@ be called initially, from an {\bf OnSize} event handler, and whenever the applic
 changes in size. It will adjust the view, object and page size according
 to the size of the window and the size of the data.
 
+\wxheading{Window styles}
+
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxSB\_HORIZONTAL}}{Specifies a horizontal scrollbar.}
+\twocolitem{\windowstyle{wxSB\_VERTICAL}}{Specifies a vertical scrollbar.}
+\end{twocollist}
+
+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
@@ -53,15 +57,15 @@ 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\_COMMAND\_SCROLL\_TOP(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
+\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_BOTTOM(id, func)}}{Catch a command to put the scroll thumb at the maximum position.}
+\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_LINEUP(id, func)}}{Catch a line up command.}
+\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_LINEDOWN(id, func)}}{Catch a line down command.}
+\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_PAGEUP(id, func)}}{Catch a page up command.}
+\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_PAGEDOWN(id, func)}}{Catch a page down command.}
+\twocolitem{{\bf EVT\_COMMAND\_SCROLL\_THUMBTRACK(id, func)}}{Catch a thumbtrack command (continuous movement of the scroll thumb).}
 \end{twocollist}%
-%
+
 \wxheading{See also}
 
 \helpref{Scrolling overview}{scrollingoverview},\rtfsp
@@ -141,15 +145,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 +211,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 +223,7 @@ Sets the position of the scrollbar.
 
 \wxheading{See also}
 
-\helpref{wxScrollBar::GetPosition}{wxscrollbargetposition}
+\helpref{wxScrollBar::GetThumbPosition}{wxscrollbargetthumbposition}
 
 \membersection{wxScrollBar::SetScrollbar}\label{wxscrollbarsetscrollbar}