#include <basiccontainer.h>

Inheritance diagram for gcn::BasicContainer:

Public Member Functions
virtual	~BasicContainer ()

virtual void	moveToTop (Widget *widget)=0

virtual void	moveToBottom (Widget *widget)=0

virtual void	getDrawSize (int &width, int &height, Widget *widget)=0

virtual void	_announceDeath (Widget *widget)=0

bool	isParentOfWidget (Widget *widget)

Public Member Functions inherited from gcn::Widget
	Widget ()

virtual	~Widget ()

virtual void	draw (Graphics *graphics)=0

virtual void	drawBorder (Graphics *)

virtual void	logic ()

virtual BasicContainer *	getParent () const

virtual void	setWidth (int width)

virtual int	getWidth () const

virtual void	setHeight (int height)

virtual int	getHeight () const

virtual void	setSize (int width, int height)

virtual void	setX (int x)

virtual int	getX () const

virtual void	setY (int y)

virtual int	getY () const

virtual void	setPosition (int x, int y)

virtual void	setDimension (const Rectangle &dimension)

virtual void	setBorderSize (unsigned int borderSize)

virtual unsigned int	getBorderSize () const

virtual const Rectangle &	getDimension () const

virtual void	setFocusable (bool focusable)

virtual bool	isFocusable () const

virtual bool	hasFocus () const

virtual void	setEnabled (bool enabled)

virtual bool	isEnabled () const

virtual void	lostFocus ()

virtual void	gotFocus ()

virtual bool	hasMouse () const

virtual void	setVisible (bool visible)

virtual bool	isVisible () const

virtual void	setBaseColor (const Color &color)

virtual const Color &	getBaseColor () const

virtual void	setForegroundColor (const Color &color)

virtual const Color &	getForegroundColor () const

virtual void	setBackgroundColor (const Color &color)

virtual const Color &	getBackgroundColor () const

virtual void	setDisabledColor (const Color &color)

virtual const Color &	getDisabledColor () const

virtual void	_mouseInputMessage (const MouseInput &mouseInput)

virtual bool	_keyInputMessage (const KeyInput &keyInput)

virtual void	hotKeyPress ()

virtual void	hotKeyRelease ()

virtual void	_mouseInMessage ()

virtual void	_mouseOutMessage ()

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

virtual void	_setFocusHandler (FocusHandler *focusHandler)

virtual FocusHandler *	_getFocusHandler ()

virtual void	addActionListener (ActionListener *actionListener)

virtual void	removeActionListener (ActionListener *actionListener)

virtual void	addMouseListener (MouseListener *mouseListener)

virtual void	removeMouseListener (MouseListener *mouseListener)

virtual void	addKeyListener (KeyListener *keyListener)

virtual void	removeKeyListener (KeyListener *keyListener)

virtual void	setEventId (const std::string &eventId)

virtual const std::string &	getEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	_setParent (BasicContainer *parent)

Font *	getFont () const

virtual void	setFont (Font *font)

virtual void	fontChanged ()

virtual int	getHotKey () const

virtual void	setHotKey (const int key)

virtual void	setHotKey (const char *key)

virtual bool	isTabInEnabled () const

virtual void	setTabInEnabled (bool enabled)

virtual bool	isTabOutEnabled () const

virtual void	setTabOutEnabled (bool enabled)

virtual bool	isDragged () const

virtual void	requestModalFocus ()

virtual void	releaseModalFocus ()

virtual bool	hasModalFocus () const

virtual void	setDirty (bool dirty)

virtual bool	getDirty () const

Additional Inherited Members
Static Public Member Functions inherited from gcn::Widget
static void	setGlobalFont (Font *font)

static bool	widgetExists (const Widget *widget)

Protected Types inherited from gcn::Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

Protected Member Functions inherited from gcn::Widget
void	generateAction ()

Protected Attributes inherited from gcn::Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Color	mDisabledColor

FocusHandler *	mFocusHandler

BasicContainer *	mParent

Rectangle	mDimension

unsigned int	mBorderSize

std::string	mEventId

int	mClickTimeStamp

int	mClickCount

int	mClickButton

bool	mHasMouse

bool	mFocusable

bool	mVisible

bool	mTabIn

bool	mTabOut

bool	mEnabled

Font *	mCurrentFont

int	mHotKey

bool	mDirty

Static Protected Attributes inherited from gcn::Widget
static DefaultFont	mDefaultFont

static Font *	mGlobalFont = NULL

static std::list< Widget * >	mWidgets

Detailed Description

Containers base class. Contains basic container functions every container should have. Containers should inherit from this class and implement it's functions.

See also: Container

Constructor & Destructor Documentation

◆ ~BasicContainer()

virtual gcn::BasicContainer::~BasicContainer ( )

inlinevirtual

Member Function Documentation

◆ _announceDeath()

virtual void gcn::BasicContainer::_announceDeath ( Widget * widget )

pure virtual

Called when a child of the BasicContainer gets destroyed.

Parameters

widget the destroyed Widget.

Implemented in gcn::ScrollArea, gcn::Window, gcn::DropDown, and gcn::Container.

◆ getDrawSize()

virtual void gcn::BasicContainer::getDrawSize	(	int &	width,
		int &	height,
		Widget *	widget
	)

pure virtual

Gets the drawing space size a Widget has in the BasicContainer. It may not be the same size as the Widgets width and height.

NOTE: Size is not checked recursively all the way back to the top Widget. If the BasicContainer itself is clipped, the size may be inaccurate.

Parameters

width	the width the Widget's draw space has.
height	the height the Widget's draw space has.
widget	the Widget calling the function.

Implemented in gcn::ScrollArea, gcn::Window, gcn::DropDown, and gcn::Container.

◆ isParentOfWidget()

bool gcn::BasicContainer::isParentOfWidget ( Widget * widget )

inline

Function to check if a widget regards this container as parent. This avoids using function calls so it can work with garbage collected widgets from Lua.

Parameters

widget

Returns: true if the parent pointer of the widget points to this container; false if the parent pointer of the widget points to something else

◆ moveToBottom()

virtual void gcn::BasicContainer::moveToBottom ( Widget * widget )

pure virtual

Moves a widget to the bottom of the BasicContainer. The Widget will be drawn below all other Widgets in the BasicContainer.

Parameters

widget the Widget to move.

Implemented in gcn::ScrollArea, gcn::Window, gcn::DropDown, and gcn::Container.

◆ moveToTop()

virtual void gcn::BasicContainer::moveToTop ( Widget * widget )

pure virtual

Moves a Widget to the top of the BasicContainer. The widget will be drawn above all other Widgets in the BasicContainer.

Parameters

widget the Widget to move.

Implemented in gcn::ScrollArea, gcn::Window, gcn::DropDown, and gcn::Container.

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

src/guichan/include/guichan/basiccontainer.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~BasicContainer()

Member Function Documentation

◆ _announceDeath()

◆ getDrawSize()

◆ isParentOfWidget()

◆ moveToBottom()

◆ moveToTop()