gcn::Icon Class Reference

#include <icon.hpp>

Inheritance diagram for gcn::Icon:

gcn::Widget List of all members.

Detailed Description

An Icon for displaying images.

Definition at line 69 of file icon.hpp.

Public Member Functions

 Icon (Image *image)
 Constructor.
virtual void draw (Graphics *graphics)
 Draws the Widget.
virtual void drawBorder (Graphics *graphics)
 Draws the Widget border.

Protected Attributes

ImagemImage


Constructor & Destructor Documentation

gcn::Icon::Icon ( Image image  ) 

Constructor.

Parameters:
image an Image to display.

Definition at line 70 of file icon.cpp.

References gcn::Image::getHeight(), gcn::Image::getWidth(), mImage, gcn::Widget::setHeight(), and gcn::Widget::setWidth().


Member Function Documentation

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.

Definition at line 77 of file icon.cpp.

References gcn::Graphics::drawImage(), and mImage.

void gcn::Icon::drawBorder ( Graphics graphics  )  [virtual]

Draws 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.

Definition at line 83 of file icon.cpp.

References gcn::Color::a, gcn::Graphics::drawLine(), gcn::Widget::getBaseColor(), gcn::Widget::getBorderSize(), gcn::Widget::getHeight(), gcn::Widget::getWidth(), and gcn::Graphics::setColor().


The documentation for this class was generated from the following files:
Generated on Sat Jul 29 19:38:49 2006 for Guichan by  doxygen 1.4.7