Inheritance diagram for CEGUI::Static:
Public Member Functions | |
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. | |
ColourRect | getFrameColours (void) const |
Return a ColourRect object containing the colours used when rendering this widget. | |
ColourRect | getBackgroundColours (void) const |
Return a ColourRect object containing the colours used when rendering this widget. | |
virtual Rect | getUnclippedInnerRect (void) const |
Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering. | |
const Image * | getImageForFrameLocation (FrameLocation location) const |
Return the Image being used for the specified location of the frame. | |
const Image * | getBackgroundImage (void) const |
Return the Image currently set as the background image for the widget. | |
void | setFrameEnabled (bool setting) |
Enable or disable rendering of the frame for this static widget. | |
void | setFrameImages (const Image *topleft, const Image *topright, const Image *bottomleft, const Image *bottomright, const Image *left, const Image *top, const Image *right, const Image *bottom) |
specify the Image objects to use for each part of the frame. A NULL may be used to omit any part. | |
void | setFrameColours (const ColourRect &colours) |
Sets the colours to be applied when rendering the frame. | |
void | setFrameColours (const colour &top_left_colour, const colour &top_right_colour, const colour &bottom_left_colour, const colour &bottom_right_colour) |
Sets the colours to be applied when rendering the frame. | |
void | setFrameColours (const colour &col) |
Sets the colour to be applied when rendering the frame. | |
void | setBackgroundEnabled (bool setting) |
Enable or disable rendering of the background for this static widget. | |
void | setBackgroundImage (const Image *image) |
Set the image to use as the background for the static widget. | |
void | setBackgroundImage (const String &imageset, const String &image) |
Set the image to use as the background for the static widget. | |
void | setBackgroundColours (const ColourRect &colours) |
Sets the colours to be applied when rendering the background. | |
void | setBackgroundColours (const colour &top_left_colour, const colour &top_right_colour, const colour &bottom_left_colour, const colour &bottom_right_colour) |
Sets the colours to be applied when rendering the background. | |
void | setBackgroundColours (const colour &col) |
Sets the colour to be applied when rendering the background. | |
void | setImageForFrameLocation (FrameLocation location, const Image *image) |
Set the Image to use for the specified location of the frame. | |
Static (const String &type, const String &name) | |
Constructor for static widget base class. | |
virtual | ~Static (void) |
Destructor for static widget base class. | |
Static Public Attributes | |
static const String | EventNamespace |
Namespace for global events. | |
Protected Member Functions | |
virtual void | populateRenderCache () |
Update the rendering cache. | |
virtual void | onSized (WindowEventArgs &e) |
Handler called when the window's size changes. | |
virtual void | onAlphaChanged (WindowEventArgs &e) |
Handler called when the window's alpha blend value is changed. | |
void | updateRenderableFrameColours (void) |
update the internal RenderableFrame with currently set colours and alpha settings. | |
colour | calculateModulatedAlphaColour (const colour &col, float alpha) const |
return ARGB colour value col, with its alpha component modulated by the value specified in float alpha. | |
virtual void | onStaticFrameChanged (WindowEventArgs &e) |
This is used internally to indicate that the frame for the static widget has been modified, and as such derived classes may need to adjust their layouts or reconfigure their rendering somehow. | |
virtual bool | testClassName_impl (const String &class_name) const |
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy. | |
Protected Attributes | |
bool | d_frameEnabled |
True when the frame is enabled. | |
ColourRect | d_frameCols |
Used to store frame colours. | |
RenderableFrame | d_frame |
Frame object used for rendering a frame for the static element. | |
bool | d_backgroundEnabled |
true when the background is enabled. | |
ColourRect | d_backgroundCols |
Colours to use when drawing background. | |
const Image * | d_background |
Image to use for widget background. | |
float | d_left_width |
Width of the left edge image for the current frame. | |
float | d_right_width |
Width of the right edge image for the current frame. | |
float | d_top_height |
Height of the top edge image for the current frame. | |
float | d_bottom_height |
Height of the bottom edge image for the current frame. |
|
Return a ColourRect object containing the colours used when rendering this widget.
|
|
Return the Image currently set as the background image for the widget.
|
|
Return a ColourRect object containing the colours used when rendering this widget.
|
|
Return the Image being used for the specified location of the frame.
|
|
Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering.
Reimplemented from CEGUI::Window. Reimplemented in CEGUI::StaticText. |
|
Return whether the background for this static widget is enabled to disabled.
|
|
Return whether the frame for this static widget is enabled or disabled.
|
|
Handler called when the window's alpha blend value is changed.
Reimplemented from CEGUI::Window. Reimplemented in CEGUI::StaticImage. |
|
Handler called when the window's size changes.
Reimplemented from CEGUI::Window. Reimplemented in CEGUI::StaticImage, and CEGUI::StaticText. |
|
This is used internally to indicate that the frame for the static widget has been modified, and as such derived classes may need to adjust their layouts or reconfigure their rendering somehow.
Reimplemented in CEGUI::StaticImage. |
|
Update the rendering cache. Populates the Window's RenderCache with imagery to be sent to the renderer. Reimplemented from CEGUI::Window. Reimplemented in CEGUI::StaticImage, and CEGUI::StaticText. |
|
Sets the colour to be applied when rendering the background.
|
|
Sets the colours to be applied when rendering the background.
|
|
Sets the colours to be applied when rendering the background.
|
|
Enable or disable rendering of the background for this static widget.
|
|
Set the image to use as the background for the static widget.
|
|
Set the image to use as the background for the static widget.
|
|
Sets the colour to be applied when rendering the frame.
|
|
Sets the colours to be applied when rendering the frame.
|
|
Sets the colours to be applied when rendering the frame.
|
|
Enable or disable rendering of the frame for this static widget. Frame imagery can be customised via the setFrameImages method.
|
|
specify the Image objects to use for each part of the frame. A NULL may be used to omit any part.
|
|
Set the Image to use for the specified location of the frame.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Window. Reimplemented in CEGUI::StaticImage, CEGUI::StaticText, and CEGUI::TabPane. |