Inheritance diagram for CEGUI::StaticImage:
Public Types | |
enum | HorzFormatting { LeftAligned, RightAligned, HorzCentred, HorzStretched, HorzTiled } |
Enumeration of horizontal formatting options for static image widgets. More... | |
enum | VertFormatting { TopAligned, BottomAligned, VertCentred, VertStretched, VertTiled } |
Enumeration of vertical formatting options for a static image widgets. More... | |
Public Member Functions | |
StaticImage (const String &type, const String &name) | |
Constructor for StaticImage widgets. | |
virtual | ~StaticImage (void) |
Destructor for StaticImage widgets. | |
const Image * | getImage (void) const |
Return a pointer to the current image displayed by this static image widget. | |
ColourRect | getImageColours (void) const |
Return a ColourRect object containing the colours used when rendering this widget. | |
HorzFormatting | getHorizontalFormatting (void) const |
Return the current horizontal formatting option set for this widget. | |
VertFormatting | getVerticalFormatting (void) const |
Return the current vertical formatting option set for this widget. | |
void | setImage (const Image *image) |
Set the Image object to be drawn by this widget. | |
void | setImage (const String &imageset, const String &image) |
Set the Image object to be drawn by this widget. | |
void | setImageColours (const ColourRect &colours) |
Sets the colours to be applied when rendering the image. | |
void | setImageColours (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 image. | |
void | setImageColours (const colour &col) |
Sets the colour to be applied when rendering the image. | |
void | setFormatting (HorzFormatting h_fmt, VertFormatting v_fmt) |
Set the formatting required for the image. | |
void | setVerticalFormatting (VertFormatting v_fmt) |
Set the formatting required for the image. | |
void | setHorizontalFormatting (HorzFormatting h_fmt) |
Set the formatting required for the image. | |
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. | |
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. | |
void | updateRenderableImageColours (void) |
update the internal RenderableImage with currently set colours and alpha settings. | |
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 | |
RenderableImage | d_image |
RenderableImage that does most of the work for us. | |
ColourRect | d_imageCols |
Colours to use for the image. |
This base class performs it's own rendering. There is no need to override this widget to perform rendering of static images.
|
Enumeration of horizontal formatting options for static image widgets.
|
|
Enumeration of vertical formatting options for a static image widgets.
|
|
Return the current horizontal formatting option set for this widget.
|
|
Return a pointer to the current image displayed by this static image widget.
|
|
Return a ColourRect object containing the colours used when rendering this widget.
|
|
Return the current vertical formatting option set for this widget.
|
|
Handler called when the window's alpha blend value is changed.
Reimplemented from CEGUI::Static. |
|
Handler called when the window's size changes.
Reimplemented from CEGUI::Static. |
|
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 from CEGUI::Static. |
|
Update the rendering cache. Populates the Window's RenderCache with imagery to be sent to the renderer. Reimplemented from CEGUI::Static. |
|
Set the formatting required for the image.
|
|
Set the formatting required for the image.
|
|
Set the Image object to be drawn by this widget.
|
|
Set the Image object to be drawn by this widget.
|
|
Sets the colour to be applied when rendering the image.
|
|
Sets the colours to be applied when rendering the image.
|
|
Sets the colours to be applied when rendering the image.
|
|
Set the formatting required for the image.
|
|
Return whether this window was inherited from the given class name at some point in the inheritance heirarchy.
Reimplemented from CEGUI::Static. |