X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..de536319f16406adf967003637b2655c61f6cb09:/interface/scrolbar.h diff --git a/interface/scrolbar.h b/interface/scrolbar.h index 1b1541ec06..d6574c6b06 100644 --- a/interface/scrolbar.h +++ b/interface/scrolbar.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: scrolbar.h -// Purpose: documentation for wxScrollBar class +// Purpose: interface of wxScrollBar // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,27 +16,29 @@ events are received. @beginStyleTable - @style{wxSB_HORIZONTAL}: + @style{wxSB_HORIZONTAL} Specifies a horizontal scrollbar. - @style{wxSB_VERTICAL}: + @style{wxSB_VERTICAL} Specifies a vertical scrollbar. @endStyleTable @library{wxcore} @category{ctrl} - @appearance{scrollbar.png} + - @seealso - @ref overview_scrollingoverview "Scrolling overview", @ref - overview_eventhandlingoverview, wxScrolledWindow + @see @ref overview_scrolling, @ref overview_eventhandling, wxScrolled */ class wxScrollBar : public wxControl { public: - //@{ + /** + Default constructor + */ + wxScrollBar(); + /** Constructor, creating and showing a scrollbar. - + @param parent Parent window. Must be non-@NULL. @param id @@ -53,17 +55,15 @@ public: Window validator. @param name Window name. - + @see Create(), wxValidator */ - wxScrollBar(); wxScrollBar(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxSB_HORIZONTAL, const wxValidator& validator = wxDefaultValidator, const wxString& name = "scrollBar"); - //@} /** Destructor, destroying the scrollbar. @@ -85,35 +85,35 @@ public: Returns the page size of the scrollbar. This is the number of scroll units that will be scrolled when the user pages up or down. Often it is the same as the thumb size. - + @see SetScrollbar() */ - int GetPageSize(); + int GetPageSize() const; /** Returns the length of the scrollbar. - + @see SetScrollbar() */ - int GetRange(); + int GetRange() const; /** Returns the current position of the scrollbar thumb. - + @see SetThumbPosition() */ - int GetThumbPosition(); + int GetThumbPosition() const; /** Returns the thumb or 'view' size. - + @see SetScrollbar() */ - int GetThumbSize(); + int GetThumbSize() const; /** Sets the scrollbar properties. - + @param position The position of the scrollbar in scroll units. @param thumbSize @@ -127,7 +127,7 @@ public: the thumb size. @param refresh @true to redraw the scrollbar, @false otherwise. - + @remarks Let's say you wish to display 50 lines of text, using the same font. The window is sized so that you can only see 16 lines at a time. @@ -138,11 +138,12 @@ public: /** Sets the position of the scrollbar. - + @param viewStart The position of the scrollbar thumb. - + @see GetThumbPosition() */ void SetThumbPosition(int viewStart); }; +