\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}
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{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}%
-%
+\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}.
+
+\input scrolevt.inc
+
\wxheading{See also}
\helpref{Scrolling overview}{scrollingoverview},\rtfsp
\latexignore{\rtfignore{\wxheading{Members}}}
-\membersection{wxScrollBar::wxScrollBar}\label{wxscrollbarconstr}
+
+\membersection{wxScrollBar::wxScrollBar}\label{wxscrollbarctor}
\func{}{wxScrollBar}{\void}
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 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.
\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.}
\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{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 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.
-See \helpref{wxScrollBar::wxScrollBar}{wxscrollbarconstr} for details.
+See \helpref{wxScrollBar::wxScrollBar}{wxscrollbarctor} for details.
+
\membersection{wxScrollBar::GetRange}\label{wxscrollbargetrange}
\helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar}
+
\membersection{wxScrollBar::GetPageSize}\label{wxscrollbargetpagesize}
\constfunc{int}{GetPageSize}{\void}
\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}
-\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.
\helpref{wxScrollBar::SetScrollbar}{wxscrollbarsetscrollbar}
\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.
\helpref{wxScrollBar::GetObjectLength}{wxscrollbargetobjectlength}
+
\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).
\helpref{wxScrollBar::GetPageSize}{wxscrollbargetpagesize}
\end{comment}
-\membersection{wxScrollBar::SetPosition}\label{wxscrollbarsetposition}
-\func{void}{SetPosition}{\param{const int}{ viewStart}}
+\membersection{wxScrollBar::SetThumbPosition}\label{wxscrollbarsetthumbposition}
+
+\func{void}{SetThumbPosition}{\param{int}{ viewStart}}
Sets the position of the scrollbar.
\wxheading{See also}
-\helpref{wxScrollBar::GetPosition}{wxscrollbargetposition}
+\helpref{wxScrollBar::GetThumbPosition}{wxscrollbargetthumbposition}
+
\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
-\param{const bool }{refresh = TRUE}}
+\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.
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}
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}
+
\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.
projects / wxWidgets.git / blobdiff