Crazy Eddie's GUI System  0.8.2
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
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...
 
Rectf 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...
 
Rectf getUnclippedInnerRect () const
 Get unclipped inner rectangle that our window should return from its member function with the same name.
 
- 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 void performChildWindowLayout ()
 Method called to perform extended laying out of the window's attached child windows.
 
virtual void getRenderingContext (RenderingContext &ctx) const
 update the RenderingContext as needed for our window. This is normally invoked via our window's member function with the same name.
 
virtual void update (float)
 perform any time based updates for this WindowRenderer.
 
virtual bool handleFontRenderSizeChange (const Font *const font)
 Perform any updates needed because the given font's render size has changed. More...
 

Static Public Attributes

static const String TypeName
 type name for this widget.
 

Protected Member Functions

Rectf getItemRenderingArea (bool hscroll, bool vscroll) const
 
void onLookNFeelAssigned ()
 Handler called when a Look'N'Feel is assigned to our window.
 
void onLookNFeelUnassigned ()
 Handler called when a Look'N'Feel is removed/unassigned from our window.
 

Protected Attributes

bool d_widgetLookAssigned
 flag whether target window has looknfeel assigned yet.
 

Additional Inherited Members

- Protected Types inherited from CEGUI::WindowRenderer
typedef std::pair< Property
*, bool > 
PropertyEntry
 type used for entries in the PropertyList.
 
typedef std::vector
< PropertyEntry
CEGUI_VECTOR_ALLOC(PropertyEntry)> 
PropertyList
 type to use for the property list.
 

Detailed Description

ItemListbox class for the FalagardBase module.

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

States:

  • Enabled
  • Disabled

Named Areas:

  • ItemRenderArea
  • ItemRenderAreaHScroll
  • ItemRenderAreaVScroll
  • ItemRenderAreaHVScroll
  • - OR -
  • ItemRenderingArea
  • ItemRenderingAreaHScroll
  • ItemRenderingAreaVScroll
  • ItemRenderingAreaHVScroll

Member Function Documentation

Rectf 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.

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.