Crazy Eddie's GUI System 0.8.7
CEGUI::ImagePropertyDim Class Reference

ImageDimBase subclass that accesses an image fetched via a property. More...

#include <Dimensions.h>

+ Inheritance diagram for CEGUI::ImagePropertyDim:
+ Collaboration diagram for CEGUI::ImagePropertyDim:

Public Member Functions

 ImagePropertyDim (const String &property_name, DimensionType dim)
 Constructor. More...
 
const StringgetSourceProperty () const
 return the name of the property accessed by this ImagePropertyDim.
 
void setSourceProperty (const String &property_name)
 set the name of the property accessed by this ImagePropertyDim.
 
BaseDimclone () const
 Create an exact copy of the specialised object and return it as a pointer to a BaseDim object. More...
 
- Public Member Functions inherited from CEGUI::ImageDimBase
 ImageDimBase (DimensionType dim)
 Constructor. More...
 
DimensionType getSourceDimension () const
 Gets the source dimension type for this WidgetDim. More...
 
void setSourceDimension (DimensionType dim)
 Sets the source dimension type for this ImageDim. More...
 
float getValue (const Window &wnd) const
 Return a value that represents this dimension as absolute pixels. More...
 
float getValue (const Window &wnd, const Rectf &container) const
 Return a value that represents this dimension as absolute pixels. More...
 
- Public Member Functions inherited from CEGUI::BaseDim
virtual float getValue (const Window &wnd) const =0
 Return a value that represents this dimension as absolute pixels. More...
 
virtual float getValue (const Window &wnd, const Rectf &container) const =0
 Return a value that represents this dimension as absolute pixels. More...
 
virtual BaseDimclone () const =0
 Create an exact copy of the specialised object and return it as a pointer to a BaseDim object. More...
 
virtual void writeXMLToStream (XMLSerializer &xml_stream) const
 Writes an xml representation of this BaseDim to out_stream. More...
 
virtual bool handleFontRenderSizeChange (Window &window, const Font *font) const
 perform any processing required due to the given font having changed. More...
 

Protected Member Functions

const ImagegetSourceImage (const Window &wnd) const
 return the image instance to access More...
 
void writeXMLElementName_impl (XMLSerializer &xml_stream) const
 Implementataion method to output real xml element name. More...
 
void writeXMLElementAttributes_impl (XMLSerializer &xml_stream) const
 Implementataion method to create the element attributes. More...
 
virtual const ImagegetSourceImage (const Window &wnd) const =0
 return the image instance to access More...
 
void writeXMLElementAttributes_impl (XMLSerializer &xml_stream) const
 Implementataion method to create the element attributes. More...
 
virtual void writeXMLElementName_impl (XMLSerializer &xml_stream) const =0
 Implementataion method to output real xml element name. More...
 
virtual void writeXMLElementAttributes_impl (XMLSerializer &xml_stream) const =0
 Implementataion method to create the element attributes. More...
 

Protected Attributes

String d_propertyName
 name of the property from which to fetch the image name.
 
- Protected Attributes inherited from CEGUI::ImageDimBase
DimensionType d_what
 the dimension of the image that we are to represent.
 

Detailed Description

ImageDimBase subclass that accesses an image fetched via a property.

Constructor & Destructor Documentation

◆ ImagePropertyDim()

CEGUI::ImagePropertyDim::ImagePropertyDim ( const String property_name,
DimensionType  dim 
)

Constructor.

Parameters
property_nameString holding the name of the property on the target that will be accessed to retrieve the name of the image to be accessed by the ImageDim.
dimDimensionType value indicating which dimension of an Image that this ImageDim is to represent.

Member Function Documentation

◆ clone()

BaseDim * CEGUI::ImagePropertyDim::clone ( ) const
virtual

Create an exact copy of the specialised object and return it as a pointer to a BaseDim object.

Since the system needs to be able to copy objects derived from BaseDim, but only has knowledge of the BaseDim interface, this clone method is provided to prevent slicing issues.

Implements CEGUI::BaseDim.

◆ getSourceImage()

const Image * CEGUI::ImagePropertyDim::getSourceImage ( const Window wnd) const
protectedvirtual

return the image instance to access

Implements CEGUI::ImageDimBase.

◆ writeXMLElementAttributes_impl()

void CEGUI::ImagePropertyDim::writeXMLElementAttributes_impl ( XMLSerializer xml_stream) const
protectedvirtual

Implementataion method to create the element attributes.

Reimplemented from CEGUI::ImageDimBase.

◆ writeXMLElementName_impl()

void CEGUI::ImagePropertyDim::writeXMLElementName_impl ( XMLSerializer xml_stream) const
protectedvirtual

Implementataion method to output real xml element name.

Implements CEGUI::BaseDim.