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

Static class for the FalagardBase module. More...

+ Inheritance diagram for CEGUI::FalagardStatic:
+ Collaboration diagram for CEGUI::FalagardStatic:

Public Member Functions

 FalagardStatic (const String &type)
 type name for this widget. More...
 
bool isFrameEnabled (void) const
 Return whether the frame for this static widget is enabled or disabled. More...
 
bool isBackgroundEnabled (void) const
 Return whether the background for this static widget is enabled to disabled. More...
 
void setFrameEnabled (bool setting)
 Enable or disable rendering of the frame for this static widget. More...
 
void setBackgroundEnabled (bool setting)
 Enable or disable rendering of the background for this static widget. More...
 
virtual void render ()
 Populate render cache. More...
 
- 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 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.
 
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
 

Protected Attributes

bool d_frameEnabled
 True when the frame is enabled.
 
bool d_backgroundEnabled
 true when the background is enabled.
 
- 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.
 

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

Detailed Description

Static 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.
  • EnabledFrame - frame rendering for enabled state
  • DisabledFrame - frame rendering for disabled state.
  • WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.
  • WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.
  • NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.
  • NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.

Constructor & Destructor Documentation

CEGUI::FalagardStatic::FalagardStatic ( const String type)

type name for this widget.

Constructor

Member Function Documentation

bool CEGUI::FalagardStatic::isBackgroundEnabled ( void  ) const
inline

Return whether the background for this static widget is enabled to disabled.

Returns
true if the background is enabled and will be rendered. false if the background is disabled and will not be rendered.
bool CEGUI::FalagardStatic::isFrameEnabled ( void  ) const
inline

Return whether the frame for this static widget is enabled or disabled.

Returns
true if the frame is enabled and will be rendered. false is the frame is disabled and will not be rendered.
virtual void CEGUI::FalagardStatic::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.

Reimplemented in CEGUI::FalagardStaticText, and CEGUI::FalagardStaticImage.

void CEGUI::FalagardStatic::setBackgroundEnabled ( bool  setting)

Enable or disable rendering of the background for this static widget.

Parameters
settingtrue to enable rendering of the background. false to disable rendering of the background.
void CEGUI::FalagardStatic::setFrameEnabled ( bool  setting)

Enable or disable rendering of the frame for this static widget.

Parameters
settingtrue to enable rendering of a frame. false to disable rendering of a frame.