On wxMac don't call Refresh from FullPaint as that is the biggest

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

diff --git a/docs/latex/wx/scrolbar.tex b/docs/latex/wx/scrolbar.tex
index 89526994ebc680f9b4e02344c5e4fd22fb7734e0..fc07f50877f07bda6267d820fec29f20abc9e93e 100644 (file)
--- a/docs/latex/wx/scrolbar.tex
+++ b/docs/latex/wx/scrolbar.tex
@@ -12,6 +12,10 @@ events are received.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \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}.
 \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}.
 
 
 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}
 
 
 \wxheading{See also}
 


@@ -70,7 +59,8 @@ functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument:
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxScrollBar::wxScrollBar}\label{wxscrollbarconstr}
+
+\membersection{wxScrollBar::wxScrollBar}\label{wxscrollbarctor}

 
 \func{}{wxScrollBar}{\void}
 
 
 \func{}{wxScrollBar}{\void}
 


@@ -85,7 +75,7 @@ Constructor, creating and showing a scrollbar.
 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{parent}{Parent window. Must not be NULL.}
+\docparam{parent}{Parent window. Must be non-NULL.}

 
 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
 
 
 \docparam{id}{Window identifier. A value of -1 indicates a default value.}
 


@@ -103,12 +93,14 @@ Constructor, creating and showing a scrollbar.
 
 \helpref{wxScrollBar::Create}{wxscrollbarcreate}, \helpref{wxValidator}{wxvalidator}
 
 
 \helpref{wxScrollBar::Create}{wxscrollbarcreate}, \helpref{wxValidator}{wxvalidator}
 

-\membersection{wxScrollBar::\destruct{wxScrollBar}}
+
+\membersection{wxScrollBar::\destruct{wxScrollBar}}\label{wxscrollbardtor}

 
 \func{void}{\destruct{wxScrollBar}}{\void}
 
 Destructor, destroying the scrollbar.
 
 
 \func{void}{\destruct{wxScrollBar}}{\void}
 
 Destructor, destroying the scrollbar.
 

+

 \membersection{wxScrollBar::Create}\label{wxscrollbarcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp
 \membersection{wxScrollBar::Create}\label{wxscrollbarcreate}
 
 \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp


@@ -117,7 +109,8 @@ Destructor, destroying the scrollbar.
 \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.

-See \helpref{wxScrollBar::wxScrollBar}{wxscrollbarconstr} for details.
+See \helpref{wxScrollBar::wxScrollBar}{wxscrollbarctor} for details.
+

 
 \membersection{wxScrollBar::GetRange}\label{wxscrollbargetrange}
 
 
 \membersection{wxScrollBar::GetRange}\label{wxscrollbargetrange}
 


@@ -129,6 +122,7 @@ Returns the length of the scrollbar.
 
 \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar}
 
 
 \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar}
 

+

 \membersection{wxScrollBar::GetPageSize}\label{wxscrollbargetpagesize}
 
 \constfunc{int}{GetPageSize}{\void}
 \membersection{wxScrollBar::GetPageSize}\label{wxscrollbargetpagesize}
 
 \constfunc{int}{GetPageSize}{\void}


@@ -141,19 +135,21 @@ same as the thumb size.
 
 \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar}
 
 
 \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar}
 

-\membersection{wxScrollBar::GetPosition}\label{wxscrollbargetposition}

 
 

-\constfunc{int}{GetPosition}{\void}
+\membersection{wxScrollBar::GetThumbPosition}\label{wxscrollbargetthumbposition}

 
 

-Returns the current position of the scrollbar.
+\constfunc{int}{GetThumbPosition}{\void}
+
+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::GetThumbSize}\label{wxscrollbargetthumbsize}

 
 

-\constfunc{int}{GetThumbLength}{\void}
+\constfunc{int}{GetThumbSize}{\void}

 
 Returns the thumb or `view' size.
 
 
 Returns the thumb or `view' size.
 


@@ -162,6 +158,7 @@ Returns the thumb or `view' size.
 \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar}
 
 \begin{comment}
 \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar}
 
 \begin{comment}

+

 \membersection{wxScrollBar::SetObjectLength}\label{wxscrollbarsetobjectlength}
 
 \func{void}{SetObjectLength}{\param{int}{ objectLength}}
 \membersection{wxScrollBar::SetObjectLength}\label{wxscrollbarsetobjectlength}
 
 \func{void}{SetObjectLength}{\param{int}{ objectLength}}


@@ -187,6 +184,7 @@ contents (the object length).
 
 \helpref{wxScrollBar::GetObjectLength}{wxscrollbargetobjectlength}
 
 
 \helpref{wxScrollBar::GetObjectLength}{wxscrollbargetobjectlength}
 

+

 \membersection{wxScrollBar::SetPageSize}\label{wxscrollbarsetpagesize}
 
 \func{void}{SetPageSize}{\param{int}{ pageSize}}
 \membersection{wxScrollBar::SetPageSize}\label{wxscrollbarsetpagesize}
 
 \func{void}{SetPageSize}{\param{int}{ pageSize}}


@@ -207,9 +205,10 @@ 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}

 
 

-\func{void}{SetPosition}{\param{int}{ viewStart}}
+\membersection{wxScrollBar::SetThumbPosition}\label{wxscrollbarsetthumbposition}
+
+\func{void}{SetThumbPosition}{\param{int}{ viewStart}}

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


@@ -219,14 +218,15 @@ 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}
 
 \func{virtual void}{SetScrollbar}{\param{int }{position},\rtfsp
 \param{int }{thumbSize}, \param{int }{range},\rtfsp
 \param{int }{pageSize},\rtfsp
 
 \membersection{wxScrollBar::SetScrollbar}\label{wxscrollbarsetscrollbar}
 
 \func{virtual void}{SetScrollbar}{\param{int }{position},\rtfsp
 \param{int }{thumbSize}, \param{int }{range},\rtfsp
 \param{int }{pageSize},\rtfsp

-\param{const bool }{refresh = TRUE}}
+\param{const bool }{refresh = true}}

 
 Sets the scrollbar properties.
 
 
 Sets the scrollbar properties.
 


@@ -242,7 +242,7 @@ Sets the scrollbar properties.
 the scrollbar will scroll when it is paged up or down. Often it is the same as
 the thumb size.}
 
 the scrollbar will scroll when it is paged up or down. Often it is the same as
 the thumb size.}
 

-\docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.}
+\docparam{refresh}{true to redraw the scrollbar, false otherwise.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 


@@ -270,14 +270,16 @@ 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}
 
 \helpref{Scrolling overview}{scrollingoverview},\rtfsp
 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 
 
 \wxheading{See also}
 
 \helpref{Scrolling overview}{scrollingoverview},\rtfsp
 \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow}
 

+

 \begin{comment}
 \begin{comment}

+

 \membersection{wxScrollBar::SetViewLength}\label{wxscrollbarsetviewlength}
 
 \func{void}{SetViewLength}{\param{int}{ viewLength}}
 \membersection{wxScrollBar::SetViewLength}\label{wxscrollbarsetviewlength}
 
 \func{void}{SetViewLength}{\param{int}{ viewLength}}