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

Class that encapsulates information for a single image component. More...

+ Inheritance diagram for CEGUI::ImageryComponent:
+ Collaboration diagram for CEGUI::ImageryComponent:

List of all members.

Public Member Functions

 ImageryComponent ()
 Constructor.
const ImagegetImage () const
 Return the Image object that will be drawn by this ImageryComponent.
void setImage (const Image *image)
 Set the Image that will be drawn by this ImageryComponent.
void setImage (const String &name)
 Set the Image that will be drawn by this ImageryComponent.
VerticalFormatting getVerticalFormatting (const Window &wnd) const
 Return the current vertical formatting setting for this ImageryComponent.
void setVerticalFormatting (VerticalFormatting fmt)
 Set the vertical formatting setting for this ImageryComponent.
HorizontalFormatting getHorizontalFormatting (const Window &wnd) const
 Return the current horizontal formatting setting for this ImageryComponent.
void setHorizontalFormatting (HorizontalFormatting fmt)
 Set the horizontal formatting setting for this ImageryComponent.
void setHorizontalFormattingPropertySource (const String &property_name)
 Set the name of a property that will be used to obtain the horizontal formatting to use for this ImageryComponent.
void setVerticalFormattingPropertySource (const String &property_name)
 Set the name of a property that will be used to obtain the vertical formatting to use for this ImageryComponent.
void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this ImageryComponent to out_stream.
bool isImageFetchedFromProperty () const
 Return whether this ImageryComponent fetches it's image via a property on the target window.
const StringgetImagePropertySource () const
 Return the name of the property that will be used to determine the image for this ImageryComponent.
void setImagePropertySource (const String &property)
 Set the name of the property that will be used to determine the image for this ImageryComponent.

Protected Member Functions

void render_impl (Window &srcWindow, Rectf &destRect, const CEGUI::ColourRect *modColours, const Rectf *clipper, bool clipToDisplay) const
 Function to do main render caching work.

Protected Attributes

const Imaged_image
FormattingSetting
< VerticalFormatting
d_vertFormatting
 Vertical formatting to be applied when rendering the image component.
FormattingSetting
< HorizontalFormatting
d_horzFormatting
 Horizontal formatting to be applied when rendering the image component.
String d_imagePropertyName
 Name of the property to access to obtain the image to be used.

Detailed Description

Class that encapsulates information for a single image component.


Member Function Documentation

Return the current horizontal formatting setting for this ImageryComponent.

Returns:
One of the HorizontalFormatting enumerated values.

Return the Image object that will be drawn by this ImageryComponent.

Returns:
Image object.

Return the name of the property that will be used to determine the image for this ImageryComponent.

Returns:
String object holding the name of a Propery.

Return the current vertical formatting setting for this ImageryComponent.

Returns:
One of the VerticalFormatting enumerated values.

Return whether this ImageryComponent fetches it's image via a property on the target window.

Returns:
  • true if the image comes via a Propery.
  • false if the image is defined explicitly.

Set the horizontal formatting setting for this ImageryComponent.

Parameters:
fmtOne of the HorizontalFormatting enumerated values.
Returns:
Nothing.
void CEGUI::ImageryComponent::setImage ( const Image image)

Set the Image that will be drawn by this ImageryComponent.

Parameters:
Pointerto the Image object to be drawn by this ImageryComponent.
Returns:
Nothing.
void CEGUI::ImageryComponent::setImage ( const String name)

Set the Image that will be drawn by this ImageryComponent.

Parameters:
nameString holding the name of the Image to be rendered.
Returns:
Nothing.

Set the name of the property that will be used to determine the image for this ImageryComponent.

Parameters:
propertyString object holding the name of a Propery. The property should access a imageset & image specification.
Returns:
Nothing.

Set the vertical formatting setting for this ImageryComponent.

Parameters:
fmtOne of the VerticalFormatting enumerated values.
Returns:
Nothing.

Writes an xml representation of this ImageryComponent to out_stream.

Parameters:
xml_streamStream where xml data should be output.
Returns:
Nothing.

Member Data Documentation

CEGUI::Image to be drawn by this image component.

 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends