#include <checkbox.h>

Inheritance diagram for gcn::CheckBox:

Public Member Functions
	CheckBox ()

	CheckBox (const std::string &caption, bool marked=false)

virtual	~CheckBox ()

virtual void	drawBox (Graphics *graphics)

virtual bool	isMarked () const

virtual void	setMarked (bool marked)

virtual const std::string &	getCaption () const

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

virtual void	adjustSize ()

virtual void	draw (Graphics *graphics)

virtual void	drawBorder (Graphics *graphics)

virtual bool	keyPress (const Key &key)

virtual void	mouseClick (int x, int y, int button, int count)

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

virtual	~Widget ()

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

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

virtual void	mouseIn ()

virtual void	mouseOut ()

virtual void	mousePress (int, int, int)

virtual void	mouseRelease (int, int, int)

virtual void	mouseWheelUp (int, int)

virtual void	mouseWheelDown (int, int)

virtual void	mouseMotion (int, int)

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

virtual bool	keyRelease (const Key &)

virtual void	hotKeyPress (const Key &)

virtual void	hotKeyRelease (const Key &)

Protected Member Functions
virtual void	toggle ()

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

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

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

Protected Attributes
bool	mMarked

std::string	mCaption

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 regular CheckBox. It can be checked and unchecked.

Constructor & Destructor Documentation

◆ CheckBox() [1/2]

gcn::CheckBox::CheckBox ( )

Contructor.

◆ CheckBox() [2/2]

gcn::CheckBox::CheckBox	(	const std::string &	caption,
		bool	marked = `false`
	)

Constructor.

Parameters

caption	the CheckBox caption.
marked	true if the CheckBox should be marked.

◆ ~CheckBox()

virtual gcn::CheckBox::~CheckBox ( )

inlinevirtual

Destructor.

Member Function Documentation

◆ adjustSize()

void gcn::CheckBox::adjustSize ( )

virtual

Adjusts the CheckBox size to fit the font size.

Reimplemented in ImageCheckBox.

◆ draw()

void gcn::CheckBox::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.

Reimplemented in ImageCheckBox.

◆ drawBorder()

void gcn::CheckBox::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.

◆ drawBox()

void gcn::CheckBox::drawBox ( Graphics * graphics )

virtual

Draws the box i.a not the caption.

Parameters

graphics a Graphics object to draw with.

Reimplemented in ImageCheckBox.

◆ getCaption()

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

virtual

Gets the CheckBox caption.

Returns: the CheckBox caption.

◆ isMarked()

bool gcn::CheckBox::isMarked ( ) const

virtual

Checks if the CheckBox is marked.

Returns: true if the CheckBox is marked.

◆ keyPress()

bool gcn::CheckBox::keyPress ( const Key & )

virtual

Called if a key is pressed when the widget has keyboard focus. If a key is held down the widget will generate multiple key presses.

Parameters

key	the key pressed.

Reimplemented from gcn::KeyListener.

◆ mouseClick()

void gcn::CheckBox::mouseClick	(	int	,
		int	,
		int	,
		int
	)

virtual

Called when a mouse button is pressed and released (clicked) 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 clicked.
count	the number of clicks.

Reimplemented from gcn::MouseListener.

Reimplemented in ImageCheckBox.

◆ setCaption()

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

virtual

Sets the CheckBox caption.

Parameters

caption the CheckBox caption.

◆ setMarked()

void gcn::CheckBox::setMarked ( bool marked )

virtual

Sets the CheckBox to be marked.

Parameters

marked true if the CheckBox should be marked.

◆ toggle()

void gcn::CheckBox::toggle ( )

protectedvirtual

Toggles between marked and unmarked.

Member Data Documentation

◆ mCaption

std::string gcn::CheckBox::mCaption

protected

◆ mMarked

bool gcn::CheckBox::mMarked

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CheckBox() [1/2]

◆ CheckBox() [2/2]

◆ ~CheckBox()

Member Function Documentation

◆ adjustSize()

◆ draw()

◆ drawBorder()

◆ drawBox()

◆ getCaption()

◆ isMarked()

◆ keyPress()

◆ mouseClick()

◆ setCaption()

◆ setMarked()

◆ toggle()

Member Data Documentation

◆ mCaption

◆ mMarked