ScrollablePane class for the FalagardBase module. More...
Inheritance diagram for CEGUI::FalagardScrollablePane:
Collaboration diagram for CEGUI::FalagardScrollablePane:
Public Member Functions | |
| FalagardScrollablePane (const String &type) | |
| type name for this widget. More... | |
| void | render () |
| Populate render cache. More... | |
| Rect | getViewableArea (void) const |
| Return a Rect that described the pane's viewable area, relative to this Window, in pixels. More... | |
| Public Member Functions inherited from CEGUI::ScrollablePaneWindowRenderer | |
| ScrollablePaneWindowRenderer (const String &name) | |
| Constructor. | |
| Public Member Functions inherited from CEGUI::WindowRenderer | |
| WindowRenderer (const String &name, const String &class_name="Window") | |
| Constructor. More... | |
| virtual | ~WindowRenderer () |
| Destructor. | |
| const String & | getName () const |
| Returns the factory type name of this window renderer. | |
| Window * | getWindow () const |
| Get the window this windowrenderer is attached to. | |
| const String & | getClass () const |
| Get the "minimum" Window class this renderer requires. | |
| const WidgetLookFeel & | getLookNFeel () const |
| Get the Look'N'Feel assigned to our window. | |
| virtual Rect | getUnclippedInnerRect () const |
| Get unclipped inner rectangle that our window should return from its member function with the same name. | |
| virtual Rect | getPixelRect () const |
| Get actual pixel rectangle our window is to return from its member function with the same name. | |
| virtual void | performChildWindowLayout () |
| Method called to perform extended laying out of the window's attached child windows. | |
Static Public Attributes | |
| static const utf8 | TypeName [] = "Falagard/ScrollablePane" |
Additional Inherited Members | |
| Protected Types inherited from CEGUI::WindowRenderer | |
| typedef std::vector< Property * > | PropertyList |
| Protected Member Functions inherited from CEGUI::WindowRenderer | |
| void | registerProperty (Property *property) |
| Register a property class that will be properly managed by this window renderer. More... | |
| virtual void | onAttach () |
| Handler called when this windowrenderer is attached to a window. | |
| virtual void | onDetach () |
| Handler called when this windowrenderer is detached from its window. | |
| virtual void | onLookNFeelAssigned () |
| Handler called when a Look'N'Feel is assigned to our window. | |
| virtual void | onLookNFeelUnassigned () |
| Handler called when a Look'N'Feel is removed/unassigned from our window. | |
| Protected Attributes inherited from CEGUI::WindowRenderer | |
| Window * | d_window |
| Pointer to the window this windowrenderer is assigned to. | |
| const String | d_name |
| Name of the factory type used to create this window renderer. | |
| const String | d_class |
| Name of the widget class that is the "minimum" requirement. | |
| PropertyList | d_properties |
| The list of properties that this windowrenderer will be handling. | |
Detailed Description
ScrollablePane class for the FalagardBase module.
This class requires LookNFeel to be assigned. The LookNFeel should provide the following:
States:
- Enabled
- Disabled
Named Areas:
- ViewableArea - area where content will be drawn when no scrollbars are visible.
- ViewableAreaHScroll - area where content will be drawn when the horizontal scrollbar is visible.
- ViewableAreaVScroll - area where content will be drawn when the vertical scrollbar is visible.
- ViewableAreaHVScroll - area where content will be drawn when both scrollbars are visible.
Child Widgets: Scrollbar based widget with name suffix "__auto_vscrollbar__" Scrollbar based widget with name suffix "__auto_hscrollbar__"
Constructor & Destructor Documentation
| CEGUI::FalagardScrollablePane::FalagardScrollablePane | ( | const String & | type | ) |
type name for this widget.
Constructor
Member Function Documentation
|
virtual |
Return a Rect that described the pane's viewable area, relative to this Window, in pixels.
- Returns
- Rect object describing the ScrollablePane's viewable area.
Implements CEGUI::ScrollablePaneWindowRenderer.
References CEGUI::WindowRenderer::d_window, CEGUI::NamedArea::getArea(), CEGUI::ScrollablePane::getHorzScrollbar(), CEGUI::WindowRenderer::getLookNFeel(), CEGUI::WidgetLookFeel::getNamedArea(), CEGUI::ComponentArea::getPixelRect(), CEGUI::ScrollablePane::getVertScrollbar(), CEGUI::WidgetLookFeel::isNamedAreaDefined(), and CEGUI::Window::isVisible().
|
virtual |
Populate render cache.
This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API...
Implements CEGUI::WindowRenderer.
References CEGUI::WindowRenderer::d_window, CEGUI::WindowRenderer::getLookNFeel(), CEGUI::WidgetLookFeel::getStateImagery(), CEGUI::Window::isDisabled(), and CEGUI::StateImagery::render().
