Helper container window class which is used in the implementation of the ScrollablePane widget class. More...
Public Member Functions | |
ScrolledContainer (const String &type, const String &name) | |
Constructor for ScrolledContainer objects. | |
~ScrolledContainer (void) | |
Destructor for ScrolledContainer objects. | |
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 & | getContentArea (void) const |
Return the current content pane area for the ScrolledContainer. | |
void | setContentArea (const Rect &area) |
Set the current content pane area for the ScrolledContainer. | |
Rect | getChildExtentsArea (void) const |
Return the current extents of the attached content. | |
Rect | getUnclippedInnerRect_impl (void) const |
Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering. | |
Static Public Attributes | |
static const String | WidgetTypeName |
Type name for ScrolledContainer. | |
static const String | EventNamespace |
Namespace for global events. | |
static const String | EventContentChanged |
static const String | EventAutoSizeSettingChanged |
Protected Types | |
typedef std::multimap< Window *, Event::Connection > | ConnectionTracker |
type definition for collection used to track event connections. | |
Protected Member Functions | |
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 hierarchy. | |
virtual void | onContentChanged (WindowEventArgs &e) |
Notification method called whenever the content size may have changed. | |
virtual void | onAutoSizeSettingChanged (WindowEventArgs &e) |
Notification method called whenever the setting that controls whether the content pane is automatically sized is changed. | |
bool | handleChildSized (const EventArgs &e) |
handles notifications about child windows being moved. | |
bool | handleChildMoved (const EventArgs &e) |
handles notifications about child windows being sized. | |
void | drawSelf (const RenderingContext &) |
Perform the actual rendering for this Window. | |
Rect | getInnerRectClipper_impl () const |
Default implementation of function to return Window inner clipper area. | |
Rect | getNonClientChildWindowContentArea_impl () const |
Default implementation of function to return non-client content area. | |
Rect | getClientChildWindowContentArea_impl () const |
Default implementation of function to return client content area. | |
Rect | getHitTestRect_impl () const |
Default implementation of function to return Window hit-test area. | |
void | onChildAdded (WindowEventArgs &e) |
Handler called when a child window is added to this window. | |
void | onChildRemoved (WindowEventArgs &e) |
Handler called when a child window is removed from this window. | |
void | onParentSized (WindowEventArgs &e) |
Handler called when this window's parent window has been resized. If this window is the root / GUI Sheet window, this call will be made when the display size changes. | |
Protected Attributes | |
ConnectionTracker | d_eventConnections |
Tracks event connections we make. | |
Rect | d_contentArea |
Holds extents of the content pane. | |
bool | d_autosizePane |
true if the pane auto-sizes itself. |
Helper container window class which is used in the implementation of the ScrollablePane widget class.
void CEGUI::ScrolledContainer::drawSelf | ( | const RenderingContext & | ctx ) | [inline, protected, virtual] |
Perform the actual rendering for this Window.
ctx | RenderingContext holding the details of the RenderingSurface to be used for the Window rendering operations. |
Reimplemented from CEGUI::Window.
Rect CEGUI::ScrolledContainer::getChildExtentsArea | ( | void | ) | const |
Return the current extents of the attached content.
const Rect& CEGUI::ScrolledContainer::getContentArea | ( | void | ) | const |
Return the current content pane area for the ScrolledContainer.
Rect CEGUI::ScrolledContainer::getUnclippedInnerRect_impl | ( | void | ) | const [virtual] |
Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering.
Reimplemented from CEGUI::Window.
bool CEGUI::ScrolledContainer::isContentPaneAutoSized | ( | void | ) | const |
Return whether the content pane is auto sized.
virtual void CEGUI::ScrolledContainer::onAutoSizeSettingChanged | ( | WindowEventArgs & | e ) | [protected, virtual] |
Notification method called whenever the setting that controls whether the content pane is automatically sized is changed.
e | WindowEventArgs object. |
void CEGUI::ScrolledContainer::onChildAdded | ( | WindowEventArgs & | e ) | [protected, virtual] |
Handler called when a child window is added to this window.
e | WindowEventArgs object whose 'window' pointer field is set to the window that has been added. |
Reimplemented from CEGUI::Window.
void CEGUI::ScrolledContainer::onChildRemoved | ( | WindowEventArgs & | e ) | [protected, virtual] |
Handler called when a child window is removed from this window.
e | WindowEventArgs object whose 'window' pointer field is set the window that has been removed. |
Reimplemented from CEGUI::Window.
virtual void CEGUI::ScrolledContainer::onContentChanged | ( | WindowEventArgs & | e ) | [protected, virtual] |
Notification method called whenever the content size may have changed.
e | WindowEventArgs object. |
void CEGUI::ScrolledContainer::onParentSized | ( | WindowEventArgs & | e ) | [protected, virtual] |
Handler called when this window's parent window has been resized. If this window is the root / GUI Sheet window, this call will be made when the display size changes.
e | WindowEventArgs object whose 'window' pointer field is set the the window that caused the event; this is typically either this window's parent window, or NULL to indicate the screen size has changed. |
Reimplemented from CEGUI::Window.
void CEGUI::ScrolledContainer::setContentArea | ( | const Rect & | area ) |
Set the current content pane area for the ScrolledContainer.
area | Rect object that details the pixel extents to use for the content pane represented by this ScrolledContainer. |
void CEGUI::ScrolledContainer::setContentPaneAutoSized | ( | bool | setting ) |
Set whether the content pane should be auto-sized.
setting |
|
virtual bool CEGUI::ScrolledContainer::testClassName_impl | ( | const String & | class_name ) | const [inline, protected, virtual] |
Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
class_name | The class name that is to be checked. |
Reimplemented from CEGUI::Window.
References CEGUI::Window::testClassName_impl().
const String CEGUI::ScrolledContainer::EventAutoSizeSettingChanged [static] |
Event fired when the autosize setting changes. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the ScrolledContainer whose auto size setting has been changed.
const String CEGUI::ScrolledContainer::EventContentChanged [static] |
Event fired whenever some child changes. Handlers are passed a const WindowEventArgs reference with WindowEventArgs::window set to the ScrolledContainer for which a child window has changed.