X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f4fcc2919776cffa5e3b2f0d44dd24c41e652ff4..e4861c72be058dd9d7e12cb77127d0be523414c8:/docs/latex/wx/scrolbar.tex?ds=sidebyside diff --git a/docs/latex/wx/scrolbar.tex b/docs/latex/wx/scrolbar.tex index f1c745a7e6..fc07f50877 100644 --- a/docs/latex/wx/scrolbar.tex +++ b/docs/latex/wx/scrolbar.tex @@ -49,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\_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}% +\input scrolevt.inc \wxheading{See also} @@ -74,7 +59,8 @@ functions that take a \helpref{wxScrollEvent}{wxscrollevent} argument: \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxScrollBar::wxScrollBar}\label{wxscrollbarconstr} + +\membersection{wxScrollBar::wxScrollBar}\label{wxscrollbarctor} \func{}{wxScrollBar}{\void} @@ -89,7 +75,7 @@ Constructor, creating and showing a scrollbar. \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.} @@ -107,12 +93,14 @@ Constructor, creating and showing a scrollbar. \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. + \membersection{wxScrollBar::Create}\label{wxscrollbarcreate} \func{bool}{Create}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},\rtfsp @@ -121,7 +109,8 @@ Destructor, destroying the scrollbar. \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} @@ -133,6 +122,7 @@ Returns the length of the scrollbar. \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar} + \membersection{wxScrollBar::GetPageSize}\label{wxscrollbargetpagesize} \constfunc{int}{GetPageSize}{\void} @@ -145,6 +135,7 @@ same as the thumb size. \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar} + \membersection{wxScrollBar::GetThumbPosition}\label{wxscrollbargetthumbposition} \constfunc{int}{GetThumbPosition}{\void} @@ -155,9 +146,10 @@ Returns the current position of the scrollbar thumb. \helpref{wxScrollBar::SetThumbPosition}{wxscrollbarsetthumbposition} -\membersection{wxScrollBar::GetThumbLength}\label{wxscrollbargetthumblength} -\constfunc{int}{GetThumbLength}{\void} +\membersection{wxScrollBar::GetThumbSize}\label{wxscrollbargetthumbsize} + +\constfunc{int}{GetThumbSize}{\void} Returns the thumb or `view' size. @@ -166,6 +158,7 @@ Returns the thumb or `view' size. \helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar} \begin{comment} + \membersection{wxScrollBar::SetObjectLength}\label{wxscrollbarsetobjectlength} \func{void}{SetObjectLength}{\param{int}{ objectLength}} @@ -191,6 +184,7 @@ contents (the object length). \helpref{wxScrollBar::GetObjectLength}{wxscrollbargetobjectlength} + \membersection{wxScrollBar::SetPageSize}\label{wxscrollbarsetpagesize} \func{void}{SetPageSize}{\param{int}{ pageSize}} @@ -211,6 +205,7 @@ At present, this needs to be called {\it before} other set functions. \helpref{wxScrollBar::GetPageSize}{wxscrollbargetpagesize} \end{comment} + \membersection{wxScrollBar::SetThumbPosition}\label{wxscrollbarsetthumbposition} \func{void}{SetThumbPosition}{\param{int}{ viewStart}} @@ -225,12 +220,13 @@ Sets the position of the scrollbar. \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 -\param{const bool }{refresh = TRUE}} +\param{const bool }{refresh = true}} Sets the scrollbar properties. @@ -246,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.} -\docparam{refresh}{TRUE to redraw the scrollbar, FALSE otherwise.} +\docparam{refresh}{true to redraw the scrollbar, false otherwise.} \wxheading{Remarks} @@ -281,7 +277,9 @@ from a \helpref{wxSizeEvent}{wxsizeevent} event handler function. \helpref{Scrolling overview}{scrollingoverview},\rtfsp \helpref{wxWindow::SetScrollbar}{wxwindowsetscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} + \begin{comment} + \membersection{wxScrollBar::SetViewLength}\label{wxscrollbarsetviewlength} \func{void}{SetViewLength}{\param{int}{ viewLength}}