mention that doing SetFocus() results in the focus event being sent

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

diff --git a/docs/latex/wx/scrolbar.tex b/docs/latex/wx/scrolbar.tex
index 3836a838d7f205e8eccdc260aeb4a7c361fed819..f1c745a7e61740c501f75d03e4a457abde132cf2 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}
 
 \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}
 
 
 \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.
 
 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
 \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.}
 \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}%
 \end{twocollist}%

-%
+

 \wxheading{See also}
 
 \helpref{Scrolling overview}{scrollingoverview},\rtfsp
 \wxheading{See also}
 
 \helpref{Scrolling overview}{scrollingoverview},\rtfsp


@@ -76,9 +80,9 @@ functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument:
 
 Default constructor.
 
 
 Default constructor.
 

-\func{}{wxScrollBar}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp
+\func{}{wxScrollBar}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp

 \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp

-\param{const long}{ style = wxSB\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
+\param{long}{ style = wxSB\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp

 \param{const wxString\& }{name = ``scrollBar"}}
 
 Constructor, creating and showing a scrollbar.
 \param{const wxString\& }{name = ``scrollBar"}}
 
 Constructor, creating and showing a scrollbar.


@@ -111,9 +115,9 @@ Destructor, destroying the scrollbar.
 
 \membersection{wxScrollBar::Create}\label{wxscrollbarcreate}
 
 
 \membersection{wxScrollBar::Create}\label{wxscrollbarcreate}
 

-\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp
+\func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp

 \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
 \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp

-\param{const long}{ style = wxSB\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp
+\param{long}{ style = wxSB\_HORIZONTAL}, \param{const wxValidator\& }{validator = wxDefaultValidator},\rtfsp

 \param{const wxString\& }{name = ``scrollBar"}}
 
 Scrollbar creation function called by the scrollbar constructor.
 \param{const wxString\& }{name = ``scrollBar"}}
 
 Scrollbar creation function called by the scrollbar constructor.


@@ -141,15 +145,15 @@ same as the thumb size.
 
 \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar}
 
 
 \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}
 
 
 \wxheading{See also}
 

-\helpref{wxScrollBar::SetPosition}{wxscrollbarsetposition}
+\helpref{wxScrollBar::SetThumbPosition}{wxscrollbarsetthumbposition}

 
 \membersection{wxScrollBar::GetThumbLength}\label{wxscrollbargetthumblength}
 
 
 \membersection{wxScrollBar::GetThumbLength}\label{wxscrollbargetthumblength}
 


@@ -164,7 +168,7 @@ Returns the thumb or `view' size.
 \begin{comment}
 \membersection{wxScrollBar::SetObjectLength}\label{wxscrollbarsetobjectlength}
 
 \begin{comment}
 \membersection{wxScrollBar::SetObjectLength}\label{wxscrollbarsetobjectlength}
 

-\func{void}{SetObjectLength}{\param{const int}{ objectLength}}
+\func{void}{SetObjectLength}{\param{int}{ objectLength}}

 
 Sets the object length for the scrollbar. This is the total object size (virtual size). You must
 call \helpref{SetViewLength}{wxscrollbarsetviewlength} {\it before} calling SetObjectLength.
 
 Sets the object length for the scrollbar. This is the total object size (virtual size). You must
 call \helpref{SetViewLength}{wxscrollbarsetviewlength} {\it before} calling SetObjectLength.


@@ -189,7 +193,7 @@ contents (the object length).
 
 \membersection{wxScrollBar::SetPageSize}\label{wxscrollbarsetpagesize}
 
 
 \membersection{wxScrollBar::SetPageSize}\label{wxscrollbarsetpagesize}
 

-\func{void}{SetPageSize}{\param{const int}{ pageSize}}
+\func{void}{SetPageSize}{\param{int}{ pageSize}}

 
 Sets the page size for the scrollbar. This is the number of scroll units which are scrolled when the
 user pages down (clicks on the scrollbar outside the thumbtrack area).
 
 Sets the page size for the scrollbar. This is the number of scroll units which are scrolled when the
 user pages down (clicks on the scrollbar outside the thumbtrack area).


@@ -207,9 +211,9 @@ At present, this needs to be called {\it before} other set functions.
 \helpref{wxScrollBar::GetPageSize}{wxscrollbargetpagesize}
 \end{comment}
 
 \helpref{wxScrollBar::GetPageSize}{wxscrollbargetpagesize}
 \end{comment}
 

-\membersection{wxScrollBar::SetPosition}\label{wxscrollbarsetposition}
+\membersection{wxScrollBar::SetThumbPosition}\label{wxscrollbarsetthumbposition}

 
 

-\func{void}{SetPosition}{\param{const int}{ viewStart}}
+\func{void}{SetThumbPosition}{\param{int}{ viewStart}}

 
 Sets the position of the scrollbar.
 
 
 Sets the position of the scrollbar.
 


@@ -219,13 +223,13 @@ Sets the position of the scrollbar.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxScrollBar::GetPosition}{wxscrollbargetposition}
+\helpref{wxScrollBar::GetThumbPosition}{wxscrollbargetthumbposition}

 
 \membersection{wxScrollBar::SetScrollbar}\label{wxscrollbarsetscrollbar}
 
 
 \membersection{wxScrollBar::SetScrollbar}\label{wxscrollbarsetscrollbar}
 

-\func{virtual void}{SetScrollbar}{\param{const int }{position},\rtfsp
-\param{const int }{thumbSize}, \param{const int }{range},\rtfsp
-\param{const int }{pageSize},\rtfsp
+\func{virtual void}{SetScrollbar}{\param{int }{position},\rtfsp
+\param{int }{thumbSize}, \param{int }{range},\rtfsp
+\param{int }{pageSize},\rtfsp

 \param{const bool }{refresh = TRUE}}
 
 Sets the scrollbar properties.
 \param{const bool }{refresh = TRUE}}
 
 Sets the scrollbar properties.


@@ -270,7 +274,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
 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}
 
 
 \wxheading{See also}
 


@@ -280,7 +284,7 @@ from a \helpref{wxWindow::OnSize}{wxwindowonsize} event handler function.
 \begin{comment}
 \membersection{wxScrollBar::SetViewLength}\label{wxscrollbarsetviewlength}
 
 \begin{comment}
 \membersection{wxScrollBar::SetViewLength}\label{wxscrollbarsetviewlength}
 

-\func{void}{SetViewLength}{\param{const int}{ viewLength}}
+\func{void}{SetViewLength}{\param{int}{ viewLength}}

 
 Sets the view length for the scrollbar.
 
 
 Sets the view length for the scrollbar.