Crazy Eddies GUI System  0.6.2
Public Member Functions | Static Public Attributes | List of all members
CEGUI::FalagardItemListbox Class Reference

ItemListbox class for the FalagardBase module. More...

+ Inheritance diagram for CEGUI::FalagardItemListbox:
+ Collaboration diagram for CEGUI::FalagardItemListbox:

Public Member Functions

 FalagardItemListbox (const String &type)
 Constructor.
 
void render ()
 Populate render cache. More...
 
Rect getItemRenderArea (void) const
 Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items. More...
 
- Public Member Functions inherited from CEGUI::ItemListBaseWindowRenderer
 ItemListBaseWindowRenderer (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 StringgetName () const
 Returns the factory type name of this window renderer.
 
WindowgetWindow () const
 Get the window this windowrenderer is attached to.
 
const StringgetClass () const
 Get the "minimum" Window class this renderer requires.
 
const WidgetLookFeelgetLookNFeel () 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/ItemListbox"
 type name for this widget.
 

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
Windowd_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

ItemListbox class for the FalagardBase module.

This class requires LookNFeel to be assigned. The LookNFeel should provide the following:

States:

Named Areas: ItemRenderArea ItemRenderAreaHScroll ItemRenderAreaVScroll ItemRenderAreaHVScroll

Member Function Documentation

Rect CEGUI::FalagardItemListbox::getItemRenderArea ( void  ) const
virtual

Return a Rect object describing, in un-clipped pixels, the window relative area that is to be used for rendering list items.

Returns
Rect object describing the window relative area of the that is to be used for rendering the items.

Implements CEGUI::ItemListBaseWindowRenderer.

References CEGUI::WindowRenderer::d_window, CEGUI::NamedArea::getArea(), CEGUI::ScrolledItemListBase::getHorzScrollbar(), CEGUI::WindowRenderer::getLookNFeel(), CEGUI::WidgetLookFeel::getNamedArea(), CEGUI::ComponentArea::getPixelRect(), CEGUI::ScrolledItemListBase::getVertScrollbar(), CEGUI::WidgetLookFeel::isNamedAreaDefined(), CEGUI::Window::isVisible(), and CEGUI::String::push_back().

void CEGUI::FalagardItemListbox::render ( )
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().