Class that encapsulates information for a single image component.
More...
List of all members.
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.
const Image* CEGUI::ImageryComponent::getImage |
( |
|
) |
const |
const String& CEGUI::ImageryComponent::getImagePropertySource |
( |
|
) |
const |
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.
bool CEGUI::ImageryComponent::isImageFetchedFromProperty |
( |
|
) |
const |
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:
-
| fmt | One of the HorizontalFormatting enumerated values. |
- Returns:
- Nothing.
void CEGUI::ImageryComponent::setImage |
( |
const Image * |
image |
) |
|
void CEGUI::ImageryComponent::setImage |
( |
const String & |
imageset, |
|
|
const String & |
image | |
|
) |
| | |
Set the Image that will be drawn by this ImageryComponent.
- Parameters:
-
| imageset | String holding the name of the Imagset that contains the Image to be rendered. |
| image | String holding the name of the Image to be rendered. |
- Returns:
- Nothing.
void CEGUI::ImageryComponent::setImagePropertySource |
( |
const String & |
property |
) |
|
Set the name of the property that will be used to determine the image for this ImageryComponent.
- Parameters:
-
| property | String 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:
-
| fmt | One of the VerticalFormatting enumerated values. |
- Returns:
- Nothing.
void CEGUI::ImageryComponent::writeXMLToStream |
( |
XMLSerializer & |
xml_stream |
) |
const |
Writes an xml representation of this ImageryComponent to out_stream.
- Parameters:
-
| xml_stream | Stream where xml data should be output. |
- Returns:
- Nothing.