CEGUI::ComponentArea Class Reference

Class that represents a target area for a widget or imagery component. More...

Inheritance diagram for CEGUI::ComponentArea:

Collaboration diagram for CEGUI::ComponentArea:

Public Member Functions
Rectf	getPixelRect (const Window &wnd) const
	Return a Rect describing the absolute pixel area represented by this ComponentArea. More...
Rectf	getPixelRect (const Window &wnd, const Rectf &container) const
	Return a Rectd describing the absolute pixel area represented by this ComponentArea. More...
void	writeXMLToStream (XMLSerializer &xml_stream) const
	Writes an xml representation of this ComponentArea to out_stream. More...
bool	isAreaFetchedFromProperty () const
	Return whether this ComponentArea fetches it's area via a property on the target window. More...
const String &	getAreaPropertySource () const
	Return the name of the property that will be used to determine the pixel area for this ComponentArea. More...
void	setAreaPropertySource (const String &property)
	Set the name of the property that will be used to determine the pixel area for this ComponentArea. More...
void	setNamedAreaSouce (const String &widget_look, const String &area_name)
	Set the named area source of the ComponentArea.
bool	isAreaFetchedFromNamedArea () const
	Return whether this ComponentArea fetches it's area via a named area defined. More...
bool	handleFontRenderSizeChange (Window &window, const Font *font) const
	perform any processing required due to the given font having changed.

Public Attributes
Dimension	d_left
	Left edge of the area.
Dimension	d_top
	Top edge of the area.
Dimension	d_right_or_width
	Either the right edge or the width of the area.
Dimension	d_bottom_or_height
	Either the bototm edge or the height of the area.

Detailed Description

Class that represents a target area for a widget or imagery component.

This is essentially a Rect built out of Dimension objects. Of note is that what would normally be the 'right' and 'bottom' edges may alternatively represent width and height depending upon what the assigned Dimension(s) represent.

Member Function Documentation

const String& CEGUI::ComponentArea::getAreaPropertySource

(

)

const

Return the name of the property that will be used to determine the pixel area for this ComponentArea.

Returns

String object holding the name of a Propery.

Rectf CEGUI::ComponentArea::getPixelRect

(

const Window &

wnd

)

const

Return a Rect describing the absolute pixel area represented by this ComponentArea.

Parameters

wnd	Window object to be used when calculating final pixel area.

Returns

Rectf object describing the pixels area represented by this ComponentArea when using wnd as a reference for calculating the final pixel dimensions.

Rectf CEGUI::ComponentArea::getPixelRect	(	const Window &	wnd,
		const Rectf &	container
	)		const

Return a Rectd describing the absolute pixel area represented by this ComponentArea.

Parameters

wnd	Window object to be used when calculating final pixel area.
container	Rect object to be used as a base or container when converting relative dimensions.

Returns

Rectf object describing the pixels area represented by this ComponentArea when using wnd and container as a reference for calculating the final pixel dimensions.

bool CEGUI::ComponentArea::isAreaFetchedFromNamedArea

(

)

const

Return whether this ComponentArea fetches it's area via a named area defined.

Returns

• true if the area comes via a named area defined in a WidgetLook.
• false if the area is not sourced from a named area.

bool CEGUI::ComponentArea::isAreaFetchedFromProperty

(

)

const

Return whether this ComponentArea fetches it's area via a property on the target window.

Returns

• true if the area comes via a Propery.
• false if the area is not sourced from a Property.

void CEGUI::ComponentArea::setAreaPropertySource

(

const String &

property

)

Set the name of the property that will be used to determine the pixel area for this ComponentArea.

Note

Calling this will replace any existing souce, such as a named area.

Parameters

property

String object holding the name of a Propery. The property should access a URect type property.

void CEGUI::ComponentArea::writeXMLToStream

(

XMLSerializer &

xml_stream

)

const

Writes an xml representation of this ComponentArea to out_stream.

Parameters

xml_stream

XMLSerializer where xml data should be output.