Gui::Box Class Reference

#include <GuiBox.h>

Inheritance diagram for Gui::Box:

Collaboration diagram for Gui::Box:

Public Member Functions
	Box (BoxOrientation orient)
void	PackStart (Widget *child)
void	PackEnd (Widget *child)
void	Remove (Widget *child)
virtual	~Box ()
virtual void	GetSizeRequested (float size[2])
virtual void	GetMinimumSize (float size[2])
virtual void	OnChildResizeRequest (Widget *)
virtual void	UpdateAllChildSizes ()
void	SetSizeRequest (float size[2])
void	SetSizeRequest (float x, float y)
void	SetSpacing (float spacing)
Public Member Functions inherited from Gui::Container
	Container ()
virtual	~Container ()
bool	OnMouseDown (MouseButtonEvent *e)
bool	OnMouseUp (MouseButtonEvent *e)
bool	OnMouseMotion (MouseMotionEvent *e)
void	RemoveAllChildren ()
void	DeleteAllChildren ()
void	GetChildPosition (const Widget *child, float outPos[2]) const
int	GetNumChildren ()
virtual void	Draw ()
void	ShowChildren ()
void	HideChildren ()
virtual void	Show ()
virtual void	ShowAll ()
virtual void	HideAll ()
void	SetBgColor (const Color &col)
void	SetTransparency (bool a)
void	RemoveChild (Widget *w)
Public Member Functions inherited from Gui::Widget
	Widget ()
virtual	~Widget ()
void	GetAbsolutePosition (float pos[2]) const
void	GetSize (float size[2])
void	SetSize (float w, float h)
void	ResizeRequest ()
void	SetShortcut (SDL_Keycode key, SDL_Keymod mod)
void	SetScissor (bool enabled)
bool	GetEnabled ()
void	SetEnabled (bool v)
virtual void	GrabFocus ()
bool	IsFocused ()
virtual void	Hide ()
void	HideTooltip ()
bool	IsVisible () const
Container *	GetParent () const
void	SetParent (Container *p)
void	SetToolTip (std::string s)
const std::string &	GetToolTip () const
virtual void	OnActivate ()
virtual void	OnMouseEnter ()
virtual void	OnMouseLeave ()
virtual bool	OnKeyDown (const SDL_Keysym *sym)
virtual void	OnTextInput (Uint32 unicode)
bool	IsMouseOver ()
void	OnPreShortcut (const SDL_Keysym *sym)
unsigned int	GetEventMask ()

Additional Inherited Members
Public Types inherited from Gui::Widget
enum	EventMask {   EVENT_NONE = 0 , EVENT_KEYDOWN = 1 << 0 , EVENT_KEYUP = 1 << 1 , EVENT_MOUSEDOWN = 1 << 2 ,   EVENT_MOUSEUP = 1 << 3 , EVENT_MOUSEMOTION = 1 << 4 }
Public Attributes inherited from Gui::Container
sigc::signal< void, MouseButtonEvent * >	onMouseButtonEvent
Public Attributes inherited from Gui::Widget
sigc::signal< void >	onMouseEnter
sigc::signal< void >	onMouseLeave
sigc::signal< void >	onSetSize
sigc::signal< void >	onDelete
float	w
float	h
Static Public Attributes inherited from Gui::Widget
static const unsigned int	EVENT_ALL = 0xffffffff
Protected Types inherited from Gui::Container
typedef std::list< widget_pos >	WidgetList
Protected Member Functions inherited from Gui::Container
void	PrependChild (Widget *w, float x, float y)
void	AppendChild (Widget *w, float x, float y)
void	MoveChild (Widget *w, float x, float y)
WidgetList::const_iterator	FindChild (const Widget *w) const
WidgetList::iterator	FindChild (const Widget *w)
Protected Member Functions inherited from Gui::Widget
virtual std::string	GetOverrideTooltip ()
void	UpdateOverriddenTooltip ()
Protected Attributes inherited from Gui::Container
WidgetList	m_children
Protected Attributes inherited from Gui::Widget
unsigned int	m_eventMask
struct {
SDL_Keycode   sym
SDL_Keymod   mod
}	m_shortcut

Constructor & Destructor Documentation

Box()

Gui::Box::Box

(

BoxOrientation

orient

)

~Box()

Gui::Box::~Box ( )

virtual

Here is the call graph for this function:

Member Function Documentation

GetMinimumSize()

virtual void Gui::Box::GetMinimumSize ( float  size[2] )

inlinevirtual

Reimplemented from Gui::Widget.

GetSizeRequested()

virtual void Gui::Box::GetSizeRequested ( float  size[2] )

inlinevirtual

containers call this on children. input: size[] will contain max permissible size output: size[] will contain what space the widget desires

Implements Gui::Widget.

OnChildResizeRequest()

void Gui::Box::OnChildResizeRequest ( Widget *  child )

virtual

Implements Gui::Container.

Here is the call graph for this function:

PackEnd()

void Gui::Box::PackEnd

(

Widget *

child

)

Here is the call graph for this function:

PackStart()

void Gui::Box::PackStart

(

Widget *

child

)

Here is the call graph for this function:

Remove()

void Gui::Box::Remove

(

Widget *

child

)

Here is the call graph for this function:

SetSizeRequest() [1/2]

void Gui::Box::SetSizeRequest

(

float

size[2]

)

SetSizeRequest() [2/2]

void Gui::Box::SetSizeRequest	(	float	x,
		float	y
	)

SetSpacing()

void Gui::Box::SetSpacing ( float  spacing )

inline

UpdateAllChildSizes()

void Gui::Box::UpdateAllChildSizes ( )

virtual

Implements Gui::Container.

Here is the call graph for this function:

---

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

• src/gui/GuiBox.h
• src/gui/GuiBox.cpp