/////////////////////////////////////////////////////////////////////////////
// Name: vscroll.h
-// Purpose: documentation for wxVarHScrollHelper class
+// Purpose: interface of wxVarHScrollHelper
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@library{wxcore}
@category{FIXME}
- @seealso
- wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow
+ @see wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow
*/
class wxVarHScrollHelper : public wxVarScrollHelperBase
{
/**
Returns the number of columns the target window contains.
-
+
@see SetColumnCount()
*/
size_t GetColumnCount() const;
};
+
/**
@class wxVarVScrollHelper
@wxheader{vscroll.h}
@library{wxcore}
@category{FIXME}
- @seealso
- wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow
+ @see wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow
*/
class wxVarVScrollHelper : public wxVarScrollHelperBase
{
/**
Returns the number of rows the target window contains.
-
+
@see SetRowCount()
*/
size_t GetRowCount() const;
};
+
/**
@class wxVarScrollHelperBase
@wxheader{vscroll.h}
@library{wxcore}
@category{FIXME}
- @seealso
- wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow
+ @see wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow
*/
class wxVarScrollHelperBase
{
represents 10 device units (which may not be the case since this class allows
for variable scroll unit sizes), a call to this function with a coordinate of
15 will return -85.
-
+
@see CalcUnscrolledPosition()
*/
int CalcScrolledPosition(int coord) const;
unit represents 10 device units (which may not be the case since this class
allows for variable scroll unit sizes), a call to this function with a
coordinate of 15 will return 115.
-
+
@see CalcScrolledPosition()
*/
int CalcUnscrolledPosition(int coord) const;
This function needs to be overridden in the in the derived class to return the
window size with respect to the opposing orientation. If this is a vertical
scrolled window, it should return the height.
-
+
@see GetOrientationTargetSize()
*/
virtual int GetNonOrientationTargetSize() const;
This function needs to be overridden in the in the derived class to return the
window size with respect to the orientation this helper is working with. If
this is a vertical scrolled window, it should return the width.
-
+
@see GetNonOrientationTargetSize()
*/
virtual int GetOrientationTargetSize() const;
/**
This function will return the target window this helper class is currently
scrolling.
-
+
@see SetTargetWindow()
*/
wxWindow* GetTargetWindow() const;
want it to scroll (part of) another window (e.g. a child of it in order to
scroll only a portion the area between the scrollbars like a spreadsheet where
only the cell area will move).
-
+
@see GetTargetWindow()
*/
void SetTargetWindow(wxWindow* target);
};
+
/**
@class wxVScrolledWindow
@wxheader{vscroll.h}
@library{wxcore}
@category{miscwnd}
- @seealso
- wxHScrolledWindow, wxHVScrolledWindow
+ @see wxHScrolledWindow, wxHVScrolledWindow
*/
class wxVScrolledWindow : public wxPanel
{
one.
Note that @c wxVSCROLL is always automatically added to our style, there is
no need to specify it explicitly.
-
+
@param parent
The parent window, must not be @NULL
@param id
You are encouraged to update any existing code using these function to use
the new replacements mentioned below, and avoid using these functions for
any new code as they are deprecated.
-
+
Deprecated for wxVarVScrollHelper::SetRowCount.
*/
size_t GetFirstVisibleLine();
};
+
/**
@class wxHVScrolledWindow
@wxheader{vscroll.h}
@library{wxcore}
@category{FIXME}
- @seealso
- wxHScrolledWindow, wxVScrolledWindow
+ @see wxHScrolledWindow, wxVScrolledWindow
*/
class wxHVScrolledWindow : public wxPanel
{
one.
Note that @c wxHSCROLL and @c wxVSCROLL are always automatically added
to our styles, there is no need to specify it explicitly.
-
+
@param parent
The parent window, must not be @NULL
@param id
};
+
/**
@class wxVarHVScrollHelper
@wxheader{vscroll.h}
@library{wxcore}
@category{FIXME}
- @seealso
- wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow
+ @see wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow
*/
class wxVarHVScrollHelper : public wxVarVScrollHelper
{
window (pixels) are actually moved. When this is @false, you are
responsible for repainting any invalidated areas of the window yourself to
account for the new scroll position.
-
+
@param vscrolling
Specifies if physical scrolling should be turned on when scrolling
vertically.
/**
Returns the number of columns and rows the target window contains.
-
+
@see SetRowColumnCount()
*/
wxSize GetRowColumnCount() const;
};
+
/**
@class wxHScrolledWindow
@wxheader{vscroll.h}
@library{wxcore}
@category{FIXME}
- @seealso
- wxHVScrolledWindow, wxVScrolledWindow
+ @see wxHVScrolledWindow, wxVScrolledWindow
*/
class wxHScrolledWindow : public wxPanel
{
one.
Note that @c wxHSCROLL is always automatically added to our style, there is
no need to specify it explicitly.
-
+
@param parent
The parent window, must not be @NULL
@param id
long style = 0,
const wxString& name = wxPanelNameStr);
};
+
projects / wxWidgets.git / blobdiff