Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
interface/scrolbar.h
View File

@@ -28,7 +28,7 @@
@seealso
@ref overview_scrollingoverview "Scrolling overview", @ref
overview_eventhandlingoverview "Event handling overview", wxScrolledWindow
overview_eventhandlingoverview, wxScrolledWindow
*/
class wxScrollBar : public wxControl
{
@@ -38,29 +38,23 @@ public:
Constructor, creating and showing a scrollbar.
@param parent
Parent window. Must be non-@NULL.
Parent window. Must be non-@NULL.
@param id
Window identifier. The value wxID_ANY indicates a default value.
Window identifier. The value wxID_ANY indicates a default value.
@param pos
Window position. If wxDefaultPosition is specified then a default position
is chosen.
Window position. If wxDefaultPosition is specified then a default
position is chosen.
@param size
Window size. If wxDefaultSize is specified then a default size is
chosen.
Window size. If wxDefaultSize is specified then a default size
is chosen.
@param style
Window style. See wxScrollBar.
Window style. See wxScrollBar.
@param validator
Window validator.
Window validator.
@param name
Window name.
Window name.
@sa Create(), wxValidator
@see Create(), wxValidator
*/
wxScrollBar();
wxScrollBar(wxWindow* parent, wxWindowID id,
@@ -92,28 +86,28 @@ public:
that will be scrolled when the user pages up or down. Often it is the
same as the thumb size.
@sa SetScrollbar()
@see SetScrollbar()
*/
int GetPageSize();
/**
Returns the length of the scrollbar.
@sa SetScrollbar()
@see SetScrollbar()
*/
int GetRange();
/**
Returns the current position of the scrollbar thumb.
@sa SetThumbPosition()
@see SetThumbPosition()
*/
int GetThumbPosition();
/**
Returns the thumb or 'view' size.
@sa SetScrollbar()
@see SetScrollbar()
*/
int GetThumbSize();
@@ -121,37 +115,34 @@ public:
Sets the scrollbar properties.
@param position
The position of the scrollbar in scroll units.
The position of the scrollbar in scroll units.
@param thumbSize
The size of the thumb, or visible portion of the scrollbar, in scroll units.
The size of the thumb, or visible portion of the scrollbar, in scroll units.
@param range
The maximum position of the scrollbar.
The maximum position of the scrollbar.
@param pageSize
The size of the page size in scroll units. This is the number of units
the scrollbar will scroll when it is paged up or down. Often it is the same as
the thumb size.
The size of the page size in scroll units. This is the number of units
the scrollbar will scroll when it is paged up or down. Often it is the same
as
the thumb size.
@param refresh
@true to redraw the scrollbar, @false otherwise.
@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.
font. The window is sized so that you can only see 16
lines at a time.
*/
virtual void SetScrollbar(int position, int thumbSize, int range,
int pageSize,
bool refresh = @true);
bool refresh = true);
/**
Sets the position of the scrollbar.
@param viewStart
The position of the scrollbar thumb.
The position of the scrollbar thumb.
@sa GetThumbPosition()
@see GetThumbPosition()
*/
void SetThumbPosition(int viewStart);
};