Crazy Eddies GUI System  0.7.9
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
CEGUI::FalagardItemEntry Class Reference

ItemEntry class for the FalagardBase module. More...

+ Inheritance diagram for CEGUI::FalagardItemEntry:
+ Collaboration diagram for CEGUI::FalagardItemEntry:

Public Member Functions

 FalagardItemEntry (const String &type)
 Constructor.
 
void render ()
 Populate render cache. More...
 
Size getItemPixelSize () const
 Return the "optimal" size for the item. More...
 
- Public Member Functions inherited from CEGUI::ItemEntryWindowRenderer
 ItemEntryWindowRenderer (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 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.
 

Static Public Attributes

static const utf8 TypeName []
 type name for this widget.
 

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
PropertyList
 type to use for the property list.
 
- Protected Member Functions inherited from CEGUI::WindowRenderer
void registerProperty (Property *property, const bool ban_from_xml)
 Register a property class that will be properly managed by this window renderer. More...
 
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.
 
void operator= (const WindowRenderer &)
 
- 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

ItemEntry class for the FalagardBase module.

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

States:

  • Enabled - basic rendering for enabled state.
  • Disabled - basic rendering for disabled state.

Optional states:

  • SelectedEnabled - basic rendering for enabled and selected state.
  • SelectedDisabled - basic rendering for disabled and selected state.

You only need to provide the 'Selected' states if the item will be selectable. If if the item is selected (which implies that it is selectable) only the SelectedEnabled state will be rendered.

Named areas:

  • ContentSize

Member Function Documentation

Size CEGUI::FalagardItemEntry::getItemPixelSize ( ) const
virtual

Return the "optimal" size for the item.

Returns
Size describing the size in pixel that this ItemEntry's content requires for non-clipped rendering

Implements CEGUI::ItemEntryWindowRenderer.

void CEGUI::FalagardItemEntry::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.