Crazy Eddie's GUI System  0.8.4
CEGUI::FalagardMenuItem Class Reference

MenuItem class for the FalagardBase module. More...

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

List of all members.

Public Member Functions

 FalagardMenuItem (const String &type)
 Constructor.
void render ()
 Populate render cache.
Sizef getItemPixelSize (void) const
 Return the "optimal" size for the item.
bool handleFontRenderSizeChange (const Font *const font)
 Perform any updates needed because the given font's render size has changed.

Static Public Attributes

static const String TypeName
 type name for this widget.

Protected Member Functions

const NamedAreagetContentNamedArea () const
bool parentIsMenubar () const

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

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.

bool CEGUI::FalagardMenuItem::handleFontRenderSizeChange ( const Font *const  font) [virtual]

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.

Parameters:
fontPointer to the Font whose render size has changed.
Returns:
  • 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 ( ) [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.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends