#include <window.h>

Inheritance diagram for gcn::Window:

Public Member Functions
	Window ()

	Window (const std::string &caption)

	Window (Widget *content, const std::string &caption="")

virtual	~Window ()

virtual void	setCaption (const std::string &caption)

virtual const std::string &	getCaption () const

virtual void	setAlignment (unsigned int alignment)

virtual unsigned int	getAlignment () const

virtual void	setContent (Widget *widget)

virtual Widget *	getContent () const

virtual void	setPadding (unsigned int padding)

virtual unsigned int	getPadding () const

virtual void	setTitleBarHeight (unsigned int height)

virtual unsigned int	getTitleBarHeight ()

virtual void	setMovable (bool movable)

virtual bool	isMovable () const

virtual void	resizeToContent ()

virtual void	setOpaque (bool opaque)

virtual bool	isOpaque ()

virtual void	drawContent (Graphics *graphics)

virtual void	moveToTop (Widget *widget)

virtual void	moveToBottom (Widget *widget)

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

virtual void	_announceDeath (Widget *widget)

virtual void	draw (Graphics *graphics)

virtual void	drawBorder (Graphics *graphics)

virtual void	logic ()

virtual void	_mouseInputMessage (const MouseInput &mouseInput)

virtual void	_mouseOutMessage ()

virtual void	_setFocusHandler (FocusHandler *focusHandler)

virtual void	mousePress (int x, int y, int button)

virtual void	mouseRelease (int x, int y, int button)

virtual void	mouseMotion (int x, int y)

virtual void	setDirty (bool dirty)

virtual bool	getDirty () const

Public Member Functions inherited from gcn::BasicContainer
virtual	~BasicContainer ()

bool	isParentOfWidget (Widget *widget)

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

virtual	~Widget ()

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 bool	_keyInputMessage (const KeyInput &keyInput)

virtual void	hotKeyPress ()

virtual void	hotKeyRelease ()

virtual void	_mouseInMessage ()

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

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

Public Member Functions inherited from gcn::MouseListener
virtual	~MouseListener ()

virtual void	mouseIn ()

virtual void	mouseOut ()

virtual void	mouseClick (int, int, int, int)

virtual void	mouseWheelUp (int, int)

virtual void	mouseWheelDown (int, int)

Protected Member Functions
virtual void	repositionContent ()

virtual Rectangle	getContentDimension ()

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

Protected Member Functions inherited from gcn::MouseListener
	MouseListener ()

Protected Attributes
std::string	mCaption

unsigned int	mAlignment

Widget *	mContent

unsigned int	mPadding

unsigned int	mTitleBarHeight

bool	mMouseDrag

int	mMouseXOffset

int	mMouseYOffset

bool	mMovable

bool	mOpaque

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

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

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

static Font *	mGlobalFont = NULL

static std::list< Widget * >	mWidgets

Detailed Description

A movable window which can conatin another Widget.

Constructor & Destructor Documentation

◆ Window() [1/3]

gcn::Window::Window ( )

Constructor.

◆ Window() [2/3]

gcn::Window::Window ( const std::string & caption )

Constructor.

Parameters

caption the Window caption.

◆ Window() [3/3]

gcn::Window::Window	(	Widget *	content,
		const std::string &	caption = `""`
	)

Constructor.

Parameters

content	the content Widget.
caption	the Window caption.

◆ ~Window()

gcn::Window::~Window ( )

virtual

Destructor.

Member Function Documentation

◆ _announceDeath()

void gcn::Window::_announceDeath ( Widget * widget )

virtual

Called when a child of the BasicContainer gets destroyed.

Parameters

widget the destroyed Widget.

Implements gcn::BasicContainer.

◆ _mouseInputMessage()

void gcn::Window::_mouseInputMessage ( const MouseInput & mouseInput )

virtual

Called when a Widget recieves a MouseInput.

WARNING: This function is used internally to handle all mouse messages. Don't call or overload it unless you know what you are doing.

Parameters

mouseInput the MouseInput message.

Reimplemented from gcn::Widget.

◆ _mouseOutMessage()

void gcn::Window::_mouseOutMessage ( )

virtual

Called when the mouse leaves the Widget area.

WARNING: This function is used internally be to handle mouse out messages. Don't call or overload this function unless you know what you are doing.

Reimplemented from gcn::Widget.

◆ _setFocusHandler()

void gcn::Window::_setFocusHandler ( FocusHandler * focusHandler )

virtual

Sets the FocusHandler to be used.

WARNING: This function is used internally and should not be called or overloaded unless you know what you are doing.

Parameters

focusHandler the FocusHandler to use.

Reimplemented from gcn::Widget.

◆ draw()

void gcn::Window::draw ( Graphics * graphics )

virtual

Draws the Widget. It is called by the parent widget when it is time for the Widget to draw itself. The graphics object is set up so that all drawing is relative to the Widget, i.e coordinate (0,0) is the top-left corner of the Widget. It is not possible to draw outside of a Widgets dimension.

Parameters

graphics a Graphics object to draw with.

Implements gcn::Widget.

◆ drawBorder()

void gcn::Window::drawBorder ( Graphics * )

virtual

Draws a the Widget border. A border is drawn around a Widget. The width and height of the border is therefore the Widgets height+2*bordersize. Think of a painting that has a certain size, the border surrounds the painting.

Parameters

graphics a Graphics object to draw with.

Reimplemented from gcn::Widget.

◆ drawContent()

void gcn::Window::drawContent ( Graphics * graphics )

virtual

Draws the content of the Window. This functions uses the getContentDimension to determin where to draw the content.

Parameters

graphics a Graphics object to draw with.

◆ getAlignment()

unsigned int gcn::Window::getAlignment ( ) const

virtual

Gets the alignment for the caption.

Returns: alignment of caption.

◆ getCaption()

const std::string & gcn::Window::getCaption ( ) const

virtual

Gets the Window caption.

Returns: the Window caption.

◆ getContent()

Widget * gcn::Window::getContent ( ) const

virtual

Gets the content Widget.

Returns: the contant Widget.

◆ getContentDimension()

Rectangle gcn::Window::getContentDimension ( )

protectedvirtual

Gets the area in the window that the content occupies.

◆ getDirty()

bool gcn::Window::getDirty ( ) const

virtual

Reimplemented from gcn::Widget.

◆ getDrawSize()

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

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.

Implements gcn::BasicContainer.

◆ getPadding()

unsigned int gcn::Window::getPadding ( ) const

virtual

Gets the padding.

Returns: the padding value.

◆ getTitleBarHeight()

unsigned int gcn::Window::getTitleBarHeight ( )

virtual

Gets the title bar height.

Returns: the title bar height.

◆ isMovable()

bool gcn::Window::isMovable ( ) const

virtual

Check if the window is movable.

Returns: true or false.

◆ isOpaque()

bool gcn::Window::isOpaque ( )

virtual

Checks if the Window is opaque.

Returns: true or false.

◆ logic()

void gcn::Window::logic ( )

virtual

Called for all Widgets in the gui each time Gui::logic is called. You can do logic stuff here like playing an animation.

See also: Gui

Reimplemented from gcn::Widget.

◆ mouseMotion()

void gcn::Window::mouseMotion	(	int	,
		int
	)

virtual

Called when the mouse moves and the mouse is in the Widget area or if the Widget has focus.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.

Reimplemented from gcn::MouseListener.

◆ mousePress()

void gcn::Window::mousePress	(	int	,
		int	,
		int
	)

virtual

Called when a mouse button is pressed when the mouse is in the Widget area or if the Widget has focus.

NOTE: A mouse press is NOT equal to a mouse click. Use mouseClickMessage to check for mouse clicks.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.
button	the button pressed.

Reimplemented from gcn::MouseListener.

◆ mouseRelease()

void gcn::Window::mouseRelease	(	int	,
		int	,
		int
	)

virtual

Called when a mouse button is released when the mouse is in the Widget area or if the Widget has focus.

Parameters

x	the x coordinate of the mouse relative to the Widget itself.
y	the y coordinate of the mouse relative to the Widget itself.
button	the button released.

Reimplemented from gcn::MouseListener.

◆ moveToBottom()

void gcn::Window::moveToBottom ( Widget * widget )

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.

Implements gcn::BasicContainer.

◆ moveToTop()

void gcn::Window::moveToTop ( Widget * widget )

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.

Implements gcn::BasicContainer.

◆ repositionContent()

void gcn::Window::repositionContent ( )

protectedvirtual

Moves the content to the top left corner of the window, uses getContentDimension to get the offset

◆ resizeToContent()

void gcn::Window::resizeToContent ( )

virtual

Resizes the window to fit the content.

◆ setAlignment()

void gcn::Window::setAlignment ( unsigned int alignment )

virtual

Sets the alignment for the caption.

Parameters

alignment Graphics::LEFT, Graphics::CENTER or Graphics::RIGHT.

◆ setCaption()

void gcn::Window::setCaption ( const std::string & caption )

virtual

Sets the Window caption.

Parameters

caption the Window caption.

◆ setContent()

void gcn::Window::setContent ( Widget * widget )

virtual

Sets the content Widget.

Parameters

widget the contant Widget.

◆ setDirty()

void gcn::Window::setDirty ( bool dirty )

virtual

Reimplemented from gcn::Widget.

◆ setMovable()

void gcn::Window::setMovable ( bool movable )

virtual

Sets the Window to be moveble.

Parameters

movable true or false.

◆ setOpaque()

void gcn::Window::setOpaque ( bool opaque )

virtual

Sets the Window to be opaque. If it's not opaque, the content area will not be filled with a color.

Parameters

opaque true or false.

◆ setPadding()

void gcn::Window::setPadding ( unsigned int padding )

virtual

Sets the padding of the window which is the distance between the window border and the content.

Parameters

padding the padding value.

◆ setTitleBarHeight()

void gcn::Window::setTitleBarHeight ( unsigned int height )

virtual

Sets the title bar height.

Parameters

height the title height value.

Member Data Documentation

◆ mAlignment

unsigned int gcn::Window::mAlignment

protected

◆ mCaption

std::string gcn::Window::mCaption

protected

◆ mContent

Widget* gcn::Window::mContent

protected

◆ mMouseDrag

bool gcn::Window::mMouseDrag

protected

◆ mMouseXOffset

int gcn::Window::mMouseXOffset

protected

◆ mMouseYOffset

int gcn::Window::mMouseYOffset

protected

◆ mMovable

bool gcn::Window::mMovable

protected

◆ mOpaque

bool gcn::Window::mOpaque

protected

◆ mPadding

unsigned int gcn::Window::mPadding

protected

◆ mTitleBarHeight

unsigned int gcn::Window::mTitleBarHeight

protected

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

src/guichan/include/guichan/widgets/window.h
src/guichan/widgets/window.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Window() [1/3]

◆ Window() [2/3]

◆ Window() [3/3]

◆ ~Window()

Member Function Documentation

◆ _announceDeath()

◆ _mouseInputMessage()

◆ _mouseOutMessage()

◆ _setFocusHandler()

◆ draw()

◆ drawBorder()

◆ drawContent()

◆ getAlignment()

◆ getCaption()

◆ getContent()

◆ getContentDimension()

◆ getDirty()

◆ getDrawSize()

◆ getPadding()

◆ getTitleBarHeight()

◆ isMovable()

◆ isOpaque()

◆ logic()

◆ mouseMotion()

◆ mousePress()

◆ mouseRelease()

◆ moveToBottom()

◆ moveToTop()

◆ repositionContent()

◆ resizeToContent()

◆ setAlignment()

◆ setCaption()

◆ setContent()

◆ setDirty()

◆ setMovable()

◆ setOpaque()

◆ setPadding()

◆ setTitleBarHeight()

Member Data Documentation

◆ mAlignment

◆ mCaption

◆ mContent

◆ mMouseDrag

◆ mMouseXOffset

◆ mMouseYOffset

◆ mMovable

◆ mOpaque

◆ mPadding

◆ mTitleBarHeight