CEGUI::StaticImageProperties::ImageColours Class Reference

Property to access the image colours for the StaticImage widget. More...

#include <CEGUIStaticImageProperties.h>

Inheritance diagram for CEGUI::StaticImageProperties::ImageColours:

[legend]Collaboration diagram for CEGUI::StaticImageProperties::ImageColours:

[legend]List of all members.

Public Member Functions
	ImageColours ()
String	get (const PropertyReceiver *receiver) const
	Return the current value of the Property as a String.
void	set (PropertyReceiver *receiver, const String &value)
	Sets the value of the property.
const String &	getHelp (void) const
	Return a String that describes the purpose and usage of this Property.
const String &	getName (void) const
	Return a the name of this Property.
virtual bool	isDefault (const PropertyReceiver *receiver) const
	Returns whether the property is at it's default value.
virtual String	getDefault (const PropertyReceiver *receiver) const
	Returns the default value of the Property as a String.
Protected Attributes
String	d_name
	String that stores the Property name.
String	d_help
	String that stores the Property help text.
String	d_default
	String that stores the Property default value string.

---

Detailed Description

Property to access the image colours for the StaticImage widget.

Usage:

• Name: ImageColours
• Format: "tl:[aarrggbb] tr:[aarrggbb] bl:[aarrggbb] br:[aarrggbb]".

Where:

• tl:[aarrggbb] is the top-left colour value specified as ARGB (hex).
• tr:[aarrggbb] is the top-right colour value specified as ARGB (hex).
• bl:[aarrggbb] is the bottom-left colour value specified as ARGB (hex).
• br:[aarrggbb] is the bottom-right colour value specified as ARGB (hex).

Definition at line 83 of file CEGUIStaticImageProperties.h.

---

Constructor & Destructor Documentation

CEGUI::StaticImageProperties::ImageColours::ImageColours (   )  [inline]

Definition at line 86 of file CEGUIStaticImageProperties.h.

---

Member Function Documentation

String CEGUI::StaticImageProperties::ImageColours::get (  const PropertyReceiver *  receiver  )  const [virtual]

Return the current value of the Property as a String. Parameters: receiver  Pointer to the target object. Returns: String object containing a textual representation of the current value of the Property Implements CEGUI::Property. Definition at line 50 of file CEGUIStaticImageProperties.cpp.

String CEGUI::Property::getDefault (  const PropertyReceiver *  receiver  )  const [virtual, inherited]

Returns the default value of the Property as a String. Parameters: receiver  Pointer to the target object. Returns: String object containing a textual representation of the default value for this property. Reimplemented in CEGUI::WindowProperties::AbsoluteMaxSize, CEGUI::TabControlProperties::TabHeight, CEGUI::TabControlProperties::AbsoluteTabHeight, CEGUI::TabControlProperties::TabTextPadding, and CEGUI::TabControlProperties::RelativeTabTextPadding. Definition at line 61 of file CEGUIProperty.cpp.

const String& CEGUI::Property::getHelp (  void   )  const [inline, inherited]

Return a String that describes the purpose and usage of this Property. Returns: String that contains the help text Definition at line 95 of file CEGUIProperty.h. Referenced by CEGUI::PropertySet::getPropertyHelp().

const String& CEGUI::Property::getName (  void   )  const [inline, inherited]

Return a the name of this Property. Returns: String containing the name of the Property Definition at line 105 of file CEGUIProperty.h. Referenced by CEGUI::PropertySet::addProperty().

bool CEGUI::Property::isDefault (  const PropertyReceiver *  receiver  )  const [virtual, inherited]

Returns whether the property is at it's default value. Parameters: receiver  Pointer to the target object. Returns: true if the property has it's default value. false if the property has been modified from it's default value. Reimplemented in CEGUI::WindowProperties::AbsoluteMaxSize, CEGUI::TabControlProperties::TabHeight, CEGUI::TabControlProperties::AbsoluteTabHeight, CEGUI::TabControlProperties::TabTextPadding, and CEGUI::TabControlProperties::RelativeTabTextPadding. Definition at line 53 of file CEGUIProperty.cpp. References CEGUI::Property::get().

void CEGUI::StaticImageProperties::ImageColours::set (  PropertyReceiver *  receiver, const String &  value )  [virtual]

Sets the value of the property. Parameters: receiver  Pointer to the target object. value  A String object that contains a textual representation of the new value to assign to the Property. Returns: Nothing. Exceptions: InvalidRequestException  Thrown when the Property was unable to interpret the content of value. Implements CEGUI::Property. Definition at line 56 of file CEGUIStaticImageProperties.cpp.

---

Member Data Documentation

String CEGUI::Property::d_default [protected, inherited]

String that stores the Property default value string. Definition at line 168 of file CEGUIProperty.h.

String CEGUI::Property::d_help [protected, inherited]

String that stores the Property help text. Definition at line 167 of file CEGUIProperty.h.

String CEGUI::Property::d_name [protected, inherited]

String that stores the Property name. Definition at line 166 of file CEGUIProperty.h.

---

The documentation for this class was generated from the following files:

• CEGUIStaticImageProperties.h
• CEGUIStaticImageProperties.cpp

---