Inheritance diagram for CEGUI::ScrollablePane:
Public Member Functions | |
ScrollablePane (const String &type, const String &name) | |
Constructor for the ScrollablePane base class. | |
~ScrollablePane (void) | |
Destructor for the ScrollablePane base class. | |
const ScrolledContainer * | getContentPane (void) const |
Returns a pointer to the window holding the pane contents. | |
bool | isVertScrollbarAlwaysShown (void) const |
Return whether the vertical scroll bar is always shown. | |
void | setShowVertScrollbar (bool setting) |
Set whether the vertical scroll bar should always be shown. | |
bool | isHorzScrollbarAlwaysShown (void) const |
Return whether the horizontal scroll bar is always shown. | |
void | setShowHorzScrollbar (bool setting) |
Set whether the horizontal scroll bar should always be shown. | |
bool | isContentPaneAutoSized (void) const |
Return whether the content pane is auto sized. | |
void | setContentPaneAutoSized (bool setting) |
Set whether the content pane should be auto-sized. | |
const Rect & | getContentPaneArea (void) const |
Return the current content pane area for the ScrollablePane. | |
void | setContentPaneArea (const Rect &area) |
Set the current content pane area for the ScrollablePane. | |
float | getHorizontalStepSize (void) const |
Returns the horizontal scrollbar step size as a fraction of one complete view page. | |
void | setHorizontalStepSize (float step) |
Sets the horizontal scrollbar step size as a fraction of one complete view page. | |
float | getHorizontalOverlapSize (void) const |
Returns the horizontal scrollbar overlap size as a fraction of one complete view page. | |
void | setHorizontalOverlapSize (float overlap) |
Sets the horizontal scrollbar overlap size as a fraction of one complete view page. | |
float | getHorizontalScrollPosition (void) const |
Returns the horizontal scroll position as a fraction of the complete scrollable width. | |
void | setHorizontalScrollPosition (float position) |
Sets the horizontal scroll position as a fraction of the complete scrollable width. | |
float | getVerticalStepSize (void) const |
Returns the vertical scrollbar step size as a fraction of one complete view page. | |
void | setVerticalStepSize (float step) |
Sets the vertical scrollbar step size as a fraction of one complete view page. | |
float | getVerticalOverlapSize (void) const |
Returns the vertical scrollbar overlap size as a fraction of one complete view page. | |
void | setVerticalOverlapSize (float overlap) |
Sets the vertical scrollbar overlap size as a fraction of one complete view page. | |
float | getVerticalScrollPosition (void) const |
Returns the vertical scroll position as a fraction of the complete scrollable height. | |
void | setVerticalScrollPosition (float position) |
Sets the vertical scroll position as a fraction of the complete scrollable height. | |
void | initialise (void) |
Initialises the Window based object ready for use. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | EventContentPaneChanged |
Event fired when an area on the content pane has been updated. | |
static const String | EventVertScrollbarModeChanged |
Event triggered when the vertical scroll bar 'force' setting changes. | |
static const String | EventHorzScrollbarModeChanged |
Event triggered when the horizontal scroll bar 'force' setting changes. | |
static const String | EventAutoSizeSettingChanged |
Event fired when the auto size setting changes. | |
static const String | EventContentPaneScrolled |
Event fired when the pane gets scrolled. | |
Protected Member Functions | |
virtual Scrollbar * | createHorizontalScrollbar (const String &name) const =0 |
Create a Scrollbar based widget to be used as the horizontal scrollbar. | |
virtual Scrollbar * | createVerticalScrollbar (const String &name) const =0 |
Create a Scrollbar based widget to be used as the vertical scrollbar. | |
virtual Rect | getViewableArea (void) const =0 |
Return a Rect that described the pane's viewable area, relative to this Window, in pixels. | |
void | addScrollablePaneEvents (void) |
Add ScrollablePane specific events. | |
void | configureScrollbars (void) |
display required integrated scroll bars according to current size of the ScrollablePane view area and the size of the attached ScrolledContainer. | |
bool | isVertScrollbarNeeded (void) const |
Return whether the vertical scrollbar is needed. | |
bool | isHorzScrollbarNeeded (void) const |
Return whether the horizontal scrollbar is needed. | |
void | updateContainerPosition (void) |
Update the content container position according to the current state of the widget (like scrollbar positions, etc). | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
virtual void | onContentPaneChanged (WindowEventArgs &e) |
Event trigger method called when some pane content has changed size or location. | |
virtual void | onVertScrollbarModeChanged (WindowEventArgs &e) |
Event trigger method called when the setting that controls whether the vertical scrollbar is always shown or not, is changed. | |
virtual void | onHorzScrollbarModeChanged (WindowEventArgs &e) |
Event trigger method called when the setting that controls whether the horizontal scrollbar is always shown or not, is changed. | |
virtual void | onAutoSizeSettingChanged (WindowEventArgs &e) |
Notification method called whenever the setting that controls whether the content pane is automatically sized is changed. | |
virtual void | onContentPaneScrolled (WindowEventArgs &e) |
Notification method called whenever the content pane is scrolled via changes in the scrollbar positions. | |
bool | handleScrollChange (const EventArgs &e) |
Handler method which gets subscribed to the scrollbar position change events. | |
bool | handleContentAreaChange (const EventArgs &e) |
Handler method which gets subscribed to the ScrolledContainer content change events. | |
bool | handleAutoSizePaneChanged (const EventArgs &e) |
Handler method which gets subscribed to the ScrolledContainer auto-size setting changes. | |
void | addChild_impl (Window *wnd) |
Add given window to child list at an appropriate position. | |
void | removeChild_impl (Window *wnd) |
Remove given window from child list. | |
void | onSized (WindowEventArgs &e) |
Handler called when the window's size changes. | |
void | onMouseWheel (MouseEventArgs &e) |
Handler called when the mouse wheel (z-axis) position changes within this window's area. | |
Protected Attributes | |
bool | d_forceVertScroll |
true if vertical scrollbar should always be displayed | |
bool | d_forceHorzScroll |
true if horizontal scrollbar should always be displayed | |
Rect | d_contentRect |
holds content area so we can track changes. | |
float | d_vertStep |
vertical scroll step fraction. | |
float | d_vertOverlap |
vertical scroll overlap fraction. | |
float | d_horzStep |
horizontal scroll step fraction. | |
float | d_horzOverlap |
horizontal scroll overlap fraction. | |
Scrollbar * | d_vertScrollbar |
Scrollbar widget used for vertical scrolling. | |
Scrollbar * | d_horzScrollbar |
Scrollbar widget used for horizontal scrolling. | |
ScrolledContainer * | d_container |
ScrolledContainer widget holding the attached widgets. |
The ScrollablePane widget allows child windows to be attached which cover an area larger than the ScrollablePane itself and these child windows can be scrolled into view using the scrollbars of the scrollable pane.
|
Create a Scrollbar based widget to be used as the horizontal scrollbar.
|
|
Create a Scrollbar based widget to be used as the vertical scrollbar.
|
|
Returns a pointer to the window holding the pane contents. The purpose of this is so that attached windows may be inspected, client code may not modify the returned window in any way.
|
|
Return the current content pane area for the ScrollablePane.
|
|
Returns the horizontal scrollbar overlap size as a fraction of one complete view page.
|
|
Returns the horizontal scroll position as a fraction of the complete scrollable width.
|
|
Returns the horizontal scrollbar step size as a fraction of one complete view page.
|
|
Returns the vertical scrollbar overlap size as a fraction of one complete view page.
|
|
Returns the vertical scroll position as a fraction of the complete scrollable height.
|
|
Returns the vertical scrollbar step size as a fraction of one complete view page.
|
|
Return a Rect that described the pane's viewable area, relative to this Window, in pixels.
|
|
Initialises the Window based object ready for use.
Reimplemented from CEGUI::Window. |
|
Return whether the content pane is auto sized.
|
|
Return whether the horizontal scroll bar is always shown.
|
|
Return whether the horizontal scrollbar is needed.
|
|
Return whether the vertical scroll bar is always shown.
|
|
Return whether the vertical scrollbar is needed.
|
|
Notification method called whenever the setting that controls whether the content pane is automatically sized is changed.
|
|
Event trigger method called when some pane content has changed size or location.
|
|
Notification method called whenever the content pane is scrolled via changes in the scrollbar positions.
|
|
Event trigger method called when the setting that controls whether the horizontal scrollbar is always shown or not, is changed.
|
|
Handler called when the mouse wheel (z-axis) position changes within this window's area.
Reimplemented from CEGUI::Window. |
|
Handler called when the window's size changes.
Reimplemented from CEGUI::Window. |
|
Event trigger method called when the setting that controls whether the vertical scrollbar is always shown or not, is changed.
|
|
Set the current content pane area for the ScrollablePane.
|
|
Set whether the content pane should be auto-sized.
|
|
Sets the horizontal scrollbar overlap size as a fraction of one complete view page.
|
|
Sets the horizontal scroll position as a fraction of the complete scrollable width.
|
|
Sets the horizontal scrollbar step size as a fraction of one complete view page.
|
|
Set whether the horizontal scroll bar should always be shown.
|
|
Set whether the vertical scroll bar should always be shown.
|
|
Sets the vertical scrollbar overlap size as a fraction of one complete view page.
|
|
Sets the vertical scroll position as a fraction of the complete scrollable height.
|
|
Sets the vertical scrollbar step size as a fraction of one complete view page.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Window. |