Crazy Eddie's GUI System  0.8.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::FalagardMenuItem Class Reference

MenuItem class for the FalagardBase module. More...

+ Inheritance diagram for CEGUI::FalagardMenuItem:
+ Collaboration diagram for CEGUI::FalagardMenuItem:

Public Member Functions

 FalagardMenuItem (const String &type)
void render ()
 Populate render cache. More...
Sizef getItemPixelSize (void) const
 Return the "optimal" size for the item. More...
bool handleFontRenderSizeChange (const Font *const font)
 Perform any updates needed because the given font's render size has changed. More...
- Public Member Functions inherited from CEGUI::ItemEntryWindowRenderer
 ItemEntryWindowRenderer (const String &name)
- Public Member Functions inherited from CEGUI::WindowRenderer
 WindowRenderer (const String &name, const String &class_name="Window")
 Constructor. More...
virtual ~WindowRenderer ()
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 Rectf 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 String TypeName
 type name for this widget.

Protected Member Functions

const NamedAreagetContentNamedArea () const
bool parentIsMenubar () const

Additional Inherited Members

- Protected Types inherited from CEGUI::WindowRenderer
typedef std::pair< Property
*, bool > 
 type used for entries in the PropertyList.
typedef std::vector
< PropertyEntry
 type to use for the property list.
- Protected Attributes inherited from CEGUI::WindowRenderer
 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

MenuItem class for the FalagardBase module.

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

States (missing states will default to '***Normal'):

  • EnabledNormal
  • EnabledHover
  • EnabledPushed
  • EnabledPushedOff
  • EnabledPopupOpen
  • DisabledNormal
  • DisabledHover
  • DisabledPushed
  • DisabledPushedOff
  • DisabledPopupOpen
  • PopupClosedIcon - Additional state drawn when item has a pop-up attached (in closed state)
  • PopupOpenIcon - Additional state drawn when item has a pop-up attached (in open state)

Named Areas: ContentSize HasPopupContentSize

Member Function Documentation

Sizef CEGUI::FalagardMenuItem::getItemPixelSize ( void  ) const

Return the "optimal" size for the item.

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

Implements CEGUI::ItemEntryWindowRenderer.

bool CEGUI::FalagardMenuItem::handleFontRenderSizeChange ( const Font *const  font)

Perform any updates needed because the given font's render size has changed.

/note This base implementation deals with updates needed for various definitions in the assigned widget look. If you override, you should generally always call this base class implementation.

fontPointer to the Font whose render size has changed.
  • true if some action was taken.
  • false if no action was taken (i.e font is not used here).

Reimplemented from CEGUI::WindowRenderer.

void CEGUI::FalagardMenuItem::render ( )

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.