CEGUI::FalagardStatic Class Reference

Static class for the FalagardBase module. More...

Inheritance diagram for CEGUI::FalagardStatic:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::FalagardStatic:

Collaboration graph
[legend]

List of all members.

Public Member Functions

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

Static Public Attributes

static const utf8 TypeName [] = "Falagard/Static"

Protected Attributes

bool d_frameEnabled
 True when the frame is enabled.
bool d_backgroundEnabled
 true when the background is enabled.

Static Protected Attributes

static
FalagardStaticProperties::FrameEnabled 
d_frameEnabledProperty
static
FalagardStaticProperties::BackgroundEnabled 
d_backgroundEnabledProperty


Detailed Description

Static class for the FalagardBase module.

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

States:


Constructor & Destructor Documentation

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

type name for this widget.

Constructor

References CEGUI::WindowRenderer::registerProperty().


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.

Referenced by CEGUI::FalagardStaticProperties::BackgroundEnabled::get().

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.

Referenced by CEGUI::FalagardStaticProperties::FrameEnabled::get().

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::FalagardStaticImage, and CEGUI::FalagardStaticText.

References d_backgroundEnabled, d_frameEnabled, CEGUI::WindowRenderer::d_window, CEGUI::WindowRenderer::getLookNFeel(), CEGUI::WidgetLookFeel::getStateImagery(), CEGUI::Window::isDisabled(), and CEGUI::StateImagery::render().

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

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

Parameters:
setting true to enable rendering of the background. false to disable rendering of the background.

References d_backgroundEnabled, CEGUI::WindowRenderer::d_window, and CEGUI::Window::requestRedraw().

Referenced by CEGUI::FalagardStaticProperties::BackgroundEnabled::set().

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

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

Parameters:
setting true to enable rendering of a frame. false to disable rendering of a frame.

References d_frameEnabled, CEGUI::WindowRenderer::d_window, and CEGUI::Window::requestRedraw().

Referenced by CEGUI::FalagardStaticProperties::FrameEnabled::set().


Generated on Thu Nov 27 20:34:46 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1