CEGUI::NamedArea Class Reference

NamedArea defines an area for a component which may later be obtained and referenced by a name unique to the WidgetLook holding the NamedArea. More...

Inheritance diagram for CEGUI::NamedArea:

Collaboration diagram for CEGUI::NamedArea:

Public Member Functions
	NamedArea (const String &name)
const String &	getName () const
	Return the name of this NamedArea. More...
void	setName (const String &name)
	set the name for this NamedArea. More...
const ComponentArea &	getArea () const
	Return the ComponentArea of this NamedArea. More...
void	setArea (const ComponentArea &area)
	Set the Area for this NamedArea. More...
void	writeXMLToStream (XMLSerializer &xml_stream) const
	Writes an xml representation of this NamedArea to out_stream. More...
bool	handleFontRenderSizeChange (Window &window, const Font *font) const
	perform any processing required due to the given font having changed.
	NamedArea (const String &name)
const String &	getName () const
	Return the name of this NamedArea. More...
void	setName (const String &name)
	set the name for this NamedArea. More...
const ComponentArea &	getArea () const
	Return the ComponentArea of this NamedArea. More...
void	setArea (const ComponentArea &area)
	Set the Area for this NamedArea. More...
void	writeXMLToStream (XMLSerializer &xml_stream) const
	Writes an xml representation of this NamedArea to out_stream. More...
bool	handleFontRenderSizeChange (Window &window, const Font *font) const
	perform any processing required due to the given font having changed.

Detailed Description

NamedArea defines an area for a component which may later be obtained and referenced by a name unique to the WidgetLook holding the NamedArea.

Member Function Documentation

const ComponentArea & CEGUI::NamedArea::getArea

(

)

const

Return the ComponentArea of this NamedArea.

Returns

ComponentArea object describing the NamedArea's current target area.

Referenced by CEGUI::FalagardItemEntry::getItemPixelSize(), CEGUI::FalagardMenuItem::getItemPixelSize(), CEGUI::FalagardPopupMenu::getItemRenderArea(), CEGUI::FalagardMenubar::getItemRenderArea(), CEGUI::FalagardItemListbox::getItemRenderArea(), CEGUI::FalagardMultiColumnList::getListRenderArea(), CEGUI::FalagardListbox::getListRenderArea(), CEGUI::ComponentArea::getPixelRect(), CEGUI::FalagardMultiLineEditbox::getTextRenderArea(), CEGUI::FalagardFrameWindow::getUnclippedInnerRect(), CEGUI::WindowRenderer::getUnclippedInnerRect(), CEGUI::FalagardScrollbar::getValueFromThumb(), CEGUI::FalagardSlider::getValueFromThumb(), CEGUI::FalagardScrollablePane::getViewableArea(), CEGUI::FalagardProgressBar::render(), CEGUI::FalagardEditbox::render(), CEGUI::FalagardStaticText::render(), CEGUI::FalagardScrollbar::updateThumb(), CEGUI::FalagardSlider::updateThumb(), and CEGUI::FalagardTree::~FalagardTree().

const ComponentArea& CEGUI::NamedArea::getArea

(

)

const

Return the ComponentArea of this NamedArea.

Returns

ComponentArea object describing the NamedArea's current target area.

const String & CEGUI::NamedArea::getName

(

void

)

const

Return the name of this NamedArea.

Returns

String object holding the name of this NamedArea.

Referenced by CEGUI::WidgetLookFeel::addNamedArea(), and CEGUI::Falagard_xmlHandler::elementEndLocal().

const String& CEGUI::NamedArea::getName

(

)

const

Return the name of this NamedArea.

Returns

String object holding the name of this NamedArea.

void CEGUI::NamedArea::setArea

(

const ComponentArea &

area

)

Set the Area for this NamedArea.

Parameters

area	ComponentArea object describing a new target area for the NamedArea..

Returns

Nothing.

Referenced by CEGUI::Falagard_xmlHandler::elementEndLocal().

void CEGUI::NamedArea::setArea

(

const ComponentArea &

area

)

Set the Area for this NamedArea.

Parameters

area	ComponentArea object describing a new target area for the NamedArea..

Returns

Nothing.

void CEGUI::NamedArea::setName

(

const String &

name

)

set the name for this NamedArea.

Parameters

area	String object holding the name of this NamedArea.

Returns

Nothing.

void CEGUI::NamedArea::setName

(

const String &

name

)

set the name for this NamedArea.

Parameters

area	String object holding the name of this NamedArea.

Returns

Nothing.

void CEGUI::NamedArea::writeXMLToStream

(

XMLSerializer &

xml_stream

)

const

Writes an xml representation of this NamedArea to out_stream.

Parameters

out_stream

Stream where xml data should be output.

Returns

Nothing.

References CEGUI::XMLSerializer::attribute(), CEGUI::XMLSerializer::closeTag(), and CEGUI::XMLSerializer::openTag().

void CEGUI::NamedArea::writeXMLToStream

(

XMLSerializer &

xml_stream

)

const

Writes an xml representation of this NamedArea to out_stream.

Parameters

out_stream

Stream where xml data should be output.

Returns

Nothing.