This is an abstract class for the creation and storage of widgets to be used by other classes. More...

#include <uirenderablecontainerwidget.h>

Inheritance diagram for Mezzanine::UI::RenderableContainerWidget:

Public Member Functions
	RenderableContainerWidget (ConstString &name, const RenderableRect &Rect, Layer *PLayer)
	Class constructor.
virtual	~RenderableContainerWidget ()
	Class destructor.
virtual Button *	CreateButton (ConstString &Name, const RenderableRect &Rect)
	Creates a button within this widget.
virtual Caption *	CreateCaption (ConstString &Name, const RenderableRect &Rect, const Whole &Glyph, const String &Text)
	Creates a caption within this widget.
virtual Caption *	CreateCaption (ConstString &Name, const RenderableRect &Rect, const Real &LineHeight, const String &Text)
	Creates a caption within this widget.
virtual CheckBox *	CreateCheckBox (ConstString &Name, const RenderableRect &Rect, const Real &LineHeight, const String &LabelText)
	Creates a CheckBox within this widget.
virtual DropDownList *	CreateDropDownList (ConstString &Name, const RenderableRect &Rect, const Real &LineHeight, const UI::ScrollbarStyle &ScrollStyle)
	Creates a drop down list within this widget.
virtual ListBox *	CreateListBox (ConstString &Name, const RenderableRect &Rect, const UI::ScrollbarStyle &ScrollbarStyle)
	Creates a List Box within this widget.
virtual MarkupText *	CreateMarkupText (ConstString &Name, const RenderableRect &Rect, const Real &LineHeight, const String &Text)
	Creates a markup text within this widget.
virtual MarkupText *	CreateMarkupText (ConstString &Name, const RenderableRect &Rect, const Whole &Glyph, const String &Text)
	Creates a markup text within this widget.
virtual PagedCellGrid *	CreatePagedCellGrid (ConstString &Name, const RenderableRect &Rect, const RenderableRect &SpnRect, const UI::SpinnerStyle &SStyle, const Real &GlyphHeight)
	Creates a paged cell grid within this widget.
virtual Rectangle *	CreateRectangle (const RenderableRect &Rect)
	Creates a rectangle within this widget.
virtual Scrollbar *	CreateScrollbar (ConstString &Name, const RenderableRect &Rect, const UI::ScrollbarStyle &Style)
	Creates a Scrollbar within this widget.
virtual ScrolledCellGrid *	CreateScrolledCellGrid (ConstString &Name, const RenderableRect &Rect, const Real &Thickness, const UI::ScrollbarStyle &Style)
	Creates a scrolled cell grid within this widget.
virtual Spinner *	CreateSpinner (ConstString &Name, const RenderableRect &Rect, const UI::SpinnerStyle &SStyle, const Real &GlyphHeight)
	Creates a Spinner within this widget.
virtual TabSet *	CreateTabSet (ConstString &Name, const RenderableRect &SetRect)
	Creates a tabset within this widget.
virtual TextButton *	CreateTextButton (ConstString &Name, const RenderableRect &Rect, const Whole &Glyph, ConstString &Text)
	Creates a text button within this widget.
virtual TextButton *	CreateTextButton (ConstString &Name, const RenderableRect &Rect, const Real &LineHeight, ConstString &Text)
	Creates a text button within this widget.
virtual void	DestroyButton (UI::Button *ToBeDestroyed)
	Destroys a button.
virtual void	DestroyCaption (UI::Caption *ToBeDestroyed)
	Destroys a caption.
virtual void	DestroyMarkupText (UI::MarkupText *ToBeDestroyed)
	Destroys a markup text.
virtual void	DestroyRectangle (UI::Rectangle *ToBeDestroyed)
	Destroys a rectangle.
virtual void	DestroyWidget (UI::Widget *ToBeDestroyed)
	Destroys a widget.
virtual Button *	GetButton (ConstString &Name)
	Gets an already created button by name.
virtual Button *	GetButton (const Whole &Index)
	Gets an already created button by index.
virtual Caption *	GetCaption (const Whole &Index)
	Gets an already created caption by index.
virtual Caption *	GetCaption (ConstString &Name)
	Gets an already created caption by name.
virtual MarkupText *	GetMarkupText (ConstString &Name)
	Gets an already created markup text by name.
virtual MarkupText *	GetMarkupText (const Whole &Index)
	Gets an already created markup text by index.
virtual Whole	GetNumButtons ()
	Gets the number of buttons created and stored in this class.
virtual Whole	GetNumCaptions ()
	Gets the number of captions created and stored in this class.
virtual Whole	GetNumMarkupTexts ()
	Gets the number of markup texts created and stored in this class.
virtual Whole	GetNumRectangles ()
	Gets the number of rectangles created and stored in this class.
virtual Whole	GetNumWidgets ()
	Gets the number of widgets created and stored in this class.
virtual OffsetButtonInfo *	GetOffsetButtonInfo (const Whole &Index)
	Gets the OffsetButtonInfo of an already created button by index.
virtual OffsetButtonInfo *	GetOffsetButtonInfo (ConstString &Name)
	Gets the OffsetButtonInfo of an already created button by name.
virtual OffsetCaptionInfo *	GetOffsetCaptionInfo (const Whole &Index)
	Gets the OffsetCaptionInfo of an already created caption by index.
virtual OffsetCaptionInfo *	GetOffsetCaptionInfo (ConstString &Name)
	Gets the OffsetCaptionInfo of an already created caption by name.
virtual OffsetMarkupTextInfo *	GetOffsetMarkupTextInfo (ConstString &Name)
	Gets the OffsetMarkupTextInfo of an already created markup text by name.
virtual OffsetMarkupTextInfo *	GetOffsetMarkupTextInfo (const Whole &Index)
	Gets the OffsetMarkupTextInfo of an already created markup text by index.
virtual OffsetRectangleInfo *	GetOffsetRectangleInfo (const Whole &Index)
	Gets the OffsetRectangleInfo of an already created rectangle by index.
virtual OffsetWidgetInfo *	GetOffsetWidgetInfo (ConstString &Name)
	Gets the OffsetWidgetInfo of an already created widget by name.
virtual OffsetWidgetInfo *	GetOffsetWidgetInfo (const Whole &Index)
	Gets the OffsetWidgetInfo of an already created widget by index.
virtual Rectangle *	GetRectangle (const Whole &Index)
	Gets an already created rectangle by index.
virtual Widget *	GetWidget (const Whole &Index)
	Gets an already created widget by index.
virtual Widget *	GetWidget (ConstString &Name)
	Gets an already created widget by name.
virtual Rectangle *	GetWidgetBack ()
	Gets the background object of this widget.
virtual void	SetActualPosition (const Vector2 &Position)
	Sets the pixel position of this widget.
virtual void	SetActualSize (const Vector2 &Size)
	Sets the pixel size of this widget.
virtual void	SetPosition (const Vector2 &Position)
	Sets the relative position of this widget.
virtual void	SetSize (const Vector2 &Size)
	Sets the relative size of this widget.
virtual void	UpdateDimensions ()
	Updates the dimensions of this widget to match those of the new screen size.
Protected Member Functions
virtual Vector2	CalculateOffset (const Vector2 &NewSize, const Vector2 &OldSize, const Vector2 &EleOffset, const UI::ResizeableAnchor &Anchor)
	Calculates a new offset for an individual element.
virtual Vector2	CalculateSize (const Vector2 &NewSize, const Vector2 &OldSize, const Vector2 &EleSize, const UI::ResizeableTether &Tether)
	Calculates a new size for an individual element.
virtual bool	CheckMouseHoverImpl ()
	Child specific mouse hover method.
virtual void	SetArea (const Vector2 &Size)
	Internal function for setting the area(size) of this widget.
virtual void	SetLocation (const Vector2 &Position)
	Internal function for setting the location(position) of this widget.
virtual void	SetVisibleImpl (bool visible)
	Child specific visibility method.
virtual void	UpdateImpl (bool Force=false)
	Child specific update method.
Protected Attributes
std::vector< OffsetButtonInfo >	Buttons
std::vector< OffsetCaptionInfo >	Captions
std::vector< OffsetMarkupTextInfo >	MarkupTexts
std::vector< OffsetRectangleInfo >	Rectangles
Whole	RenderablesAdded
Rectangle *	WidgetBack
std::vector< OffsetWidgetInfo >	Widgets

Detailed Description

This is an abstract class for the creation and storage of widgets to be used by other classes.

Definition at line 77 of file uirenderablecontainerwidget.h.

Constructor & Destructor Documentation

Mezzanine::UI::RenderableContainerWidget::RenderableContainerWidget	(	ConstString &	name,
		const RenderableRect &	Rect,
		Layer *	PLayer
	)

Class constructor.

Parameters:

name	The name of the window.
Rect	The Rect representing the position and size of the window.
PLayer	The parent layer this window belongs to.

Definition at line 70 of file uirenderablecontainerwidget.cpp.

Member Function Documentation

Button * Mezzanine::UI::RenderableContainerWidget::CreateButton	(	ConstString &	Name,
		const RenderableRect &	Rect
	)		`[virtual]`

Creates a button within this widget.

Returns:: Returns a pointer to the created button.

Parameters:

Name	The name of the button.
Rect	The Rect representing the position and size of the button.

Definition at line 429 of file uirenderablecontainerwidget.cpp.

Caption * Mezzanine::UI::RenderableContainerWidget::CreateCaption	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const Whole &	Glyph,
		const String &	Text
	)		`[virtual]`

Creates a caption within this widget.

Returns:: Returns a pointer to the created caption.

Parameters:

Name	The name of this caption.
Rect	The Rect representing the position and size of the caption.
Glyph	One of the glyphs specified in your mta file. Must be valid.
Text	Any text you want printed on the caption.

Definition at line 585 of file uirenderablecontainerwidget.cpp.

Caption * Mezzanine::UI::RenderableContainerWidget::CreateCaption	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const Real &	LineHeight,
		const String &	Text
	)		`[virtual]`

Creates a caption within this widget.

Returns:: Returns a pointer to the created caption.

Parameters:

Name	The name of this caption.
Rect	The Rect representing the position and size of the caption.
LineHeight	The lineheight you want the text to have in relative units. This will automatically select the glyph and scale it for you.
Text	Any text you want printed on the caption.

Definition at line 598 of file uirenderablecontainerwidget.cpp.

CheckBox * Mezzanine::UI::RenderableContainerWidget::CreateCheckBox	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const Real &	LineHeight,
		const String &	LabelText
	)		`[virtual]`

Creates a CheckBox within this widget.

The label uses the Markup Text class, and thus it's light markup text language. You can also pass in a blank string if you don't wish to have a label, you can create a label after construction.

Returns:: Returns a pointer to the created CheckBox.

Parameters:

Name	The name of the CheckBox.
Rect	The Rect representing the position and size of the widget.
LineHeight	The lineheight you want the text to have. If the Rect passed in is relative, this will expect LineHeight to be relative as well.
LabelText	The text to display with the label.

Definition at line 818 of file uirenderablecontainerwidget.cpp.

DropDownList * Mezzanine::UI::RenderableContainerWidget::CreateDropDownList	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const Real &	LineHeight,
		const UI::ScrollbarStyle &	ScrollStyle
	)		`[virtual]`

Creates a drop down list within this widget.

Returns:: Returns a pointer to the created DropDownList.

Parameters:

Name	The Name for the Widget.
Rect	The renderable rect representing the position and size of this widget.
LineHeight	The lineheight you want the text to have. If the Rect passed in is relative, this will expect LineHeight to be relative as well.
ScrollStyle	The style of the scrollbar you want for this List Box. See Scrollbar class for more information.

Definition at line 888 of file uirenderablecontainerwidget.cpp.

ListBox * Mezzanine::UI::RenderableContainerWidget::CreateListBox	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const UI::ScrollbarStyle &	ScrollbarStyle
	)		`[virtual]`

Creates a List Box within this widget.

Returns:: Returns a pointer to the created List Box.

Parameters:

Name	The name of the List Box.
Rect	The Rect representing the position and size of the widget.
ScrollbarStyle	The style of scrollbar you want to create, see Scrollbar documentation for more details.

Definition at line 832 of file uirenderablecontainerwidget.cpp.

MarkupText * Mezzanine::UI::RenderableContainerWidget::CreateMarkupText	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const Whole &	Glyph,
		const String &	Text
	)		`[virtual]`

Creates a markup text within this widget.

The constructor will ignore the size portion of the Rect passed in, since Markup Texts don't have a default size.

Returns:: Returns a pointer to the created markup text.

Parameters:

Name	The name of this markup text.
Rect	The Rect representing the position and size of the markup text.
Glyph	One of the glyphs specified in your mta file. Must be valid.
Text	Any text you want printed on the markup text.

Definition at line 666 of file uirenderablecontainerwidget.cpp.

MarkupText * Mezzanine::UI::RenderableContainerWidget::CreateMarkupText	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const Real &	LineHeight,
		const String &	Text
	)		`[virtual]`

Creates a markup text within this widget.

The constructor will ignore the size portion of the Rect passed in, since Markup Texts don't have a default size.

Returns:: Returns a pointer to the created markup text.

Parameters:

Name	The name of this markup text.
Rect	The Rect representing the position and size of the markup text.
LineHeight	The lineheight you want the text to have in relative units. This will automatically select the glyph and scale it for you.
Text	Any text you want printed on the markup text.

Definition at line 680 of file uirenderablecontainerwidget.cpp.

PagedCellGrid * Mezzanine::UI::RenderableContainerWidget::CreatePagedCellGrid	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const RenderableRect &	SpnRect,
		const UI::SpinnerStyle &	SStyle,
		const Real &	GlyphHeight
	)		`[virtual]`

Creates a paged cell grid within this widget.

Returns:: Returns a pointer to the created PagedCellGrid.

Parameters:

Name	The name of the widget.
Rect	The Rect representing the position and size of the CellGrid.
SpnRect	The Rect representing the position and size of the Spinner.
SStyle	The style of spinner to create.
GlyphHeight	The desired lineheight of the glyphs to be used with the spinner.

Definition at line 874 of file uirenderablecontainerwidget.cpp.

Rectangle * Mezzanine::UI::RenderableContainerWidget::CreateRectangle ( const RenderableRect & Rect ) [virtual]

Creates a rectangle within this widget.

Returns:: Returns a pointer to the created rectangle.

Parameters:

Rect	The Rect representing the position and size of the rectangle.

Definition at line 543 of file uirenderablecontainerwidget.cpp.

Scrollbar * Mezzanine::UI::RenderableContainerWidget::CreateScrollbar	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const UI::ScrollbarStyle &	Style
	)		`[virtual]`

Creates a Scrollbar within this widget.

Returns:: Returns a pointer to the created Scrollbar.

Parameters:

Name	The name of the Scrollbar.
Rect	The Rect representing the position and size of the widget.
Style	The style of scrollbar you want to create, see Scrollbar documentation for more details.

Definition at line 804 of file uirenderablecontainerwidget.cpp.

ScrolledCellGrid * Mezzanine::UI::RenderableContainerWidget::CreateScrolledCellGrid	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const Real &	Thickness,
		const UI::ScrollbarStyle &	Style
	)		`[virtual]`

Creates a scrolled cell grid within this widget.

Returns:: Returns a pointer to the created ScrolledCellGrid.

Parameters:

Name	The name of the widget.
Rect	The Rect representing the position and size of the widget.
Thickness	The width of the vertical scrollbar in relative units. The same amount of actual pixels is used to determine the height of the horizontal scrollbar.
Style	An enum value representing how you want your scrollbar constructed. See class details for more info.

Definition at line 860 of file uirenderablecontainerwidget.cpp.

Spinner * Mezzanine::UI::RenderableContainerWidget::CreateSpinner	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const UI::SpinnerStyle &	SStyle,
		const Real &	GlyphHeight
	)		`[virtual]`

Creates a Spinner within this widget.

Returns:: Returns a pointer to the created Spinner.

Parameters:

Name	The Name for the Widget.
Rect	The Rect representing the position and size of the widget.
SStyle	The layout of buttons this widget will have. See SpinnerStyle enum or class description for more details.
GlyphHeight	The desired relative height of the text you want.

Definition at line 846 of file uirenderablecontainerwidget.cpp.

TabSet * Mezzanine::UI::RenderableContainerWidget::CreateTabSet	(	ConstString &	Name,
		const RenderableRect &	SetRect
	)		`[virtual]`

Creates a tabset within this widget.

Returns:: Returns a pointer to the created tabset.

Parameters:

Name	The Name for the Widget.
SetRect	The Rect representing the position and size of all the Renderable Sets generated by the tabset.

Definition at line 570 of file uilayer.cpp.

TextButton * Mezzanine::UI::RenderableContainerWidget::CreateTextButton	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const Real &	LineHeight,
		ConstString &	Text
	)		`[virtual]`

Creates a text button within this widget.

Returns:: Returns a pointer to the created button.

Parameters:

Name	The name of the button.
Rect	The Rect representing the position and size of the button.
LineHeight	The lineheight you want the text to have in relative units. This will automatically select the glyph and scale it for you.
Text	Any text you want printed on the button.

Definition at line 468 of file uirenderablecontainerwidget.cpp.

TextButton * Mezzanine::UI::RenderableContainerWidget::CreateTextButton	(	ConstString &	Name,
		const RenderableRect &	Rect,
		const Whole &	Glyph,
		ConstString &	Text
	)		`[virtual]`

Creates a text button within this widget.

Returns:: Returns a pointer to the created button.

Parameters:

Name	The name of the button.
Rect	The Rect representing the position and size of the button.
Glyph	One of the glyphs specified in your mta file. Must be valid.
Text	Any text you want printed on the button.

Definition at line 448 of file uirenderablecontainerwidget.cpp.

void Mezzanine::UI::RenderableContainerWidget::DestroyButton ( UI::Button * ToBeDestroyed ) [virtual]

Destroys a button.

Parameters:

ToBeDestroyed Pointer to the button you want destroyed.

Definition at line 530 of file uirenderablecontainerwidget.cpp.

void Mezzanine::UI::RenderableContainerWidget::DestroyCaption ( UI::Caption * ToBeDestroyed ) [virtual]

Destroys a caption.

Parameters:

ToBeDestroyed Pointer to the caption you want destroyed.

Definition at line 653 of file uirenderablecontainerwidget.cpp.

void Mezzanine::UI::RenderableContainerWidget::DestroyMarkupText ( UI::MarkupText * ToBeDestroyed ) [virtual]

Destroys a markup text.

Parameters:

ToBeDestroyed Pointer to the markup text you want destroyed.

Definition at line 736 of file uirenderablecontainerwidget.cpp.

void Mezzanine::UI::RenderableContainerWidget::DestroyRectangle ( UI::Rectangle * ToBeDestroyed ) [virtual]

Destroys a rectangle.

Parameters:

ToBeDestroyed Pointer to the rectangle you want destroyed.

Definition at line 572 of file uirenderablecontainerwidget.cpp.

void Mezzanine::UI::RenderableContainerWidget::DestroyWidget ( UI::Widget * ToBeDestroyed ) [virtual]

Destroys a widget.

Parameters:

ToBeDestroyed Pointer to the widget you want destroyed.

Definition at line 791 of file uirenderablecontainerwidget.cpp.

Button * Mezzanine::UI::RenderableContainerWidget::GetButton ( ConstString & Name ) [virtual]

Gets an already created button by name.

Returns:: Returns a pointer to the button of the specified name.

Definition at line 488 of file uirenderablecontainerwidget.cpp.

Button * Mezzanine::UI::RenderableContainerWidget::GetButton ( const Whole & Index ) [virtual]

Gets an already created button by index.

Returns:: Returns a pointer to the button at the specified index.

Definition at line 501 of file uirenderablecontainerwidget.cpp.

Caption * Mezzanine::UI::RenderableContainerWidget::GetCaption ( ConstString & Name ) [virtual]

Gets an already created caption by name.

Returns:: Returns a pointer to the caption of the specified name.

Definition at line 611 of file uirenderablecontainerwidget.cpp.

Caption * Mezzanine::UI::RenderableContainerWidget::GetCaption ( const Whole & Index ) [virtual]

Gets an already created caption by index.

Returns:: Returns a pointer to the caption at the specified index.

Definition at line 624 of file uirenderablecontainerwidget.cpp.

MarkupText * Mezzanine::UI::RenderableContainerWidget::GetMarkupText ( const Whole & Index ) [virtual]

Gets an already created markup text by index.

Returns:: Returns a pointer to the markup text at the specified index.

Definition at line 707 of file uirenderablecontainerwidget.cpp.

MarkupText * Mezzanine::UI::RenderableContainerWidget::GetMarkupText ( ConstString & Name ) [virtual]

Gets an already created markup text by name.

Returns:: Returns a pointer to the markup text of the specified name.

Definition at line 694 of file uirenderablecontainerwidget.cpp.

Whole Mezzanine::UI::RenderableContainerWidget::GetNumButtons ( ) [virtual]

Gets the number of buttons created and stored in this class.

Returns:: Returns the number of buttons this class is storing.

Definition at line 525 of file uirenderablecontainerwidget.cpp.

Whole Mezzanine::UI::RenderableContainerWidget::GetNumCaptions ( ) [virtual]

Gets the number of captions created and stored in this class.

Returns:: Returns the number of captions this class is storing.

Definition at line 648 of file uirenderablecontainerwidget.cpp.

Whole Mezzanine::UI::RenderableContainerWidget::GetNumMarkupTexts ( ) [virtual]

Gets the number of markup texts created and stored in this class.

Returns:: Returns the number of markup texts this class is storing.

Definition at line 731 of file uirenderablecontainerwidget.cpp.

Whole Mezzanine::UI::RenderableContainerWidget::GetNumRectangles ( ) [virtual]

Gets the number of rectangles created and stored in this class.

Returns:: Returns the number of rectangles this class is storing.

Definition at line 567 of file uirenderablecontainerwidget.cpp.

Whole Mezzanine::UI::RenderableContainerWidget::GetNumWidgets ( ) [virtual]

Gets the number of widgets created and stored in this class.

Returns:: Returns the number of widgets this class is storing.

Definition at line 786 of file uirenderablecontainerwidget.cpp.

OffsetButtonInfo * Mezzanine::UI::RenderableContainerWidget::GetOffsetButtonInfo ( ConstString & Name ) [virtual]

Gets the OffsetButtonInfo of an already created button by name.

Returns:: Returns a reference to the button of the specified name.

Definition at line 506 of file uirenderablecontainerwidget.cpp.

OffsetButtonInfo * Mezzanine::UI::RenderableContainerWidget::GetOffsetButtonInfo ( const Whole & Index ) [virtual]

Gets the OffsetButtonInfo of an already created button by index.

Returns:: Returns a reference to the button at the specified index.

Definition at line 519 of file uirenderablecontainerwidget.cpp.

OffsetCaptionInfo * Mezzanine::UI::RenderableContainerWidget::GetOffsetCaptionInfo ( const Whole & Index ) [virtual]

Gets the OffsetCaptionInfo of an already created caption by index.

Returns:: Returns a reference to the caption at the specified index.

Definition at line 642 of file uirenderablecontainerwidget.cpp.

OffsetCaptionInfo * Mezzanine::UI::RenderableContainerWidget::GetOffsetCaptionInfo ( ConstString & Name ) [virtual]

Gets the OffsetCaptionInfo of an already created caption by name.

Returns:: Returns a reference to the caption of the specified name.

Definition at line 629 of file uirenderablecontainerwidget.cpp.

OffsetMarkupTextInfo * Mezzanine::UI::RenderableContainerWidget::GetOffsetMarkupTextInfo ( ConstString & Name ) [virtual]

Gets the OffsetMarkupTextInfo of an already created markup text by name.

Returns:: Returns a reference to the markup text of the specified name.

Definition at line 712 of file uirenderablecontainerwidget.cpp.

OffsetMarkupTextInfo * Mezzanine::UI::RenderableContainerWidget::GetOffsetMarkupTextInfo ( const Whole & Index ) [virtual]

Gets the OffsetMarkupTextInfo of an already created markup text by index.

Returns:: Returns a reference to the markup text at the specified index.

Definition at line 725 of file uirenderablecontainerwidget.cpp.

OffsetRectangleInfo * Mezzanine::UI::RenderableContainerWidget::GetOffsetRectangleInfo ( const Whole & Index ) [virtual]

Gets the OffsetRectangleInfo of an already created rectangle by index.

Returns:: Returns a reference to the rectangle at the specified index.

Definition at line 561 of file uirenderablecontainerwidget.cpp.

OffsetWidgetInfo * Mezzanine::UI::RenderableContainerWidget::GetOffsetWidgetInfo ( ConstString & Name ) [virtual]

Gets the OffsetWidgetInfo of an already created widget by name.

Returns:: Returns a reference to the widget of the specified name.

Definition at line 767 of file uirenderablecontainerwidget.cpp.

OffsetWidgetInfo * Mezzanine::UI::RenderableContainerWidget::GetOffsetWidgetInfo ( const Whole & Index ) [virtual]

Gets the OffsetWidgetInfo of an already created widget by index.

Returns:: Returns a reference to the widget at the specified index.

Definition at line 780 of file uirenderablecontainerwidget.cpp.

Rectangle * Mezzanine::UI::RenderableContainerWidget::GetRectangle ( const Whole & Index ) [virtual]

Gets an already created rectangle by index.

Returns:: Returns a pointer to the rectangle at the specified index.

Definition at line 556 of file uirenderablecontainerwidget.cpp.

Widget * Mezzanine::UI::RenderableContainerWidget::GetWidget ( const Whole & Index ) [virtual]

Gets an already created widget by index.

Returns:: Returns a pointer to the widget at the specified index.

Definition at line 762 of file uirenderablecontainerwidget.cpp.

Widget * Mezzanine::UI::RenderableContainerWidget::GetWidget ( ConstString & Name ) [virtual]

Gets an already created widget by name.

Returns:: Returns a pointer to the widget of the specified name.

Definition at line 749 of file uirenderablecontainerwidget.cpp.

Rectangle * Mezzanine::UI::RenderableContainerWidget::GetWidgetBack ( ) [virtual]

Gets the background object of this widget.

Returns:: Returns a pointer to the rectangle that is the background for this widget.

Definition at line 424 of file uirenderablecontainerwidget.cpp.

void Mezzanine::UI::RenderableContainerWidget::SetActualPosition ( const Vector2 & Position ) [virtual]

Sets the pixel position of this widget.

Parameters:

Position A vector2 representing the pixel position of this widget.

Implements Mezzanine::UI::Widget.

Reimplemented in Mezzanine::UI::Window.

Definition at line 368 of file uirenderablecontainerwidget.cpp.

void Mezzanine::UI::RenderableContainerWidget::SetActualSize ( const Vector2 & Size ) [virtual]

Sets the pixel size of this widget.

Parameters:

Size	A vector2 representing the pixel size of this widget.

Implements Mezzanine::UI::Widget.

Reimplemented in Mezzanine::UI::Window.

Definition at line 381 of file uirenderablecontainerwidget.cpp.

void Mezzanine::UI::RenderableContainerWidget::SetPosition ( const Vector2 & Position ) [virtual]

Sets the relative position of this widget.

The position is relative to the screen size. Values range from 0.0 to 1.0.

Parameters:

Position A vector2 representing the relative position of this widget.

Implements Mezzanine::UI::Widget.

Reimplemented in Mezzanine::UI::Window.

Definition at line 361 of file uirenderablecontainerwidget.cpp.

void Mezzanine::UI::RenderableContainerWidget::SetSize ( const Vector2 & Size ) [virtual]

Sets the relative size of this widget.

The size is relative to the screen size. Values range from 0.0 to 1.0.

Parameters:

Size	A vector2 representing the relative size of this widget.

Implements Mezzanine::UI::Widget.

Reimplemented in Mezzanine::UI::Window.

Definition at line 374 of file uirenderablecontainerwidget.cpp.

void Mezzanine::UI::RenderableContainerWidget::UpdateDimensions ( ) [virtual]

Updates the dimensions of this widget to match those of the new screen size.

This function is called automatically when a viewport changes in size, and shouldn't need to be called manually.

Implements Mezzanine::UI::Widget.

Reimplemented in Mezzanine::UI::MenuWindow, and Mezzanine::UI::Window.

Definition at line 387 of file uirenderablecontainerwidget.cpp.

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

Mezzanine::UI::RenderableContainerWidget Class Reference

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation