gcn::Icon Class Reference

#include <icon.h>

Inheritance diagram for gcn::Icon:

Public Member Functions
	Icon (Image *image)
virtual void	draw (Graphics *graphics)
virtual void	drawBorder (Graphics *graphics)
virtual bool	getDirty () const
virtual void	setBaseColor (const Color &color)
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 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)

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

An Icon for displaying images.

Constructor & Destructor Documentation

Icon()

gcn::Icon::Icon

(

Image *

image

)

Constructor.

Parameters

image

an Image to display.

Member Function Documentation

draw()

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

getDirty()

bool gcn::Icon::getDirty ( ) const

virtual

Reimplemented from gcn::Widget.

setBaseColor()

void gcn::Icon::setBaseColor ( const Color &  color )

virtual

Sets the base color. The base color is the background color for many Widgets like the Button and Contianer Widgets.

Parameters

color

the baseground Color.

Reimplemented from gcn::Widget.

---

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

• src/guichan/include/guichan/widgets/icon.h
• src/guichan/widgets/icon.cpp