WoopsiUI::DecorationGlyphButton Class Reference

#include <decorationglyphbutton.h>

Inheritance diagram for WoopsiUI::DecorationGlyphButton:
WoopsiUI::Button WoopsiUI::Label WoopsiUI::Gadget WoopsiUI::SkinnedScreenDepthButton WoopsiUI::SkinnedScreenFlipButton WoopsiUI::SkinnedWindowCloseButton WoopsiUI::SkinnedWindowDepthButton WoopsiUI::WindowBorderButton

List of all members.

Public Member Functions

 DecorationGlyphButton (s16 x, s16 y, u16 width, u16 height, char normalGlyph, char clickedGlyph, FontBase *font=NULL)
virtual void draw (Rect clipRect)
virtual bool focus ()

Protected Member Functions

virtual ~DecorationGlyphButton ()
 DecorationGlyphButton (const DecorationGlyphButton &decorationGlyphButton)

Protected Attributes

char _normalGlyph
char _clickedGlyph

Detailed Description

Class representing a button that will display a glyph and form part of another gadget's border decorations. Examples include the screen flip/depth buttons.


Constructor & Destructor Documentation

DecorationGlyphButton::DecorationGlyphButton ( s16  x,
s16  y,
u16  width,
u16  height,
char  normalGlyph,
char  clickedGlyph,
FontBase font = NULL 
)

Constructor.

Parameters:
x The x co-ordinate of the button.
y The y co-ordinate of the button.
width The width of the button.
height The height of the button.
normalGlyph Character to display when unclicked.
clickedGlyph Character to display when clicked.
font Font to use.
virtual WoopsiUI::DecorationGlyphButton::~DecorationGlyphButton (  )  [inline, protected, virtual]

Destructor.

WoopsiUI::DecorationGlyphButton::DecorationGlyphButton ( const DecorationGlyphButton decorationGlyphButton  )  [inline, protected]

Copy constructor is protected to prevent usage.


Member Function Documentation

void DecorationGlyphButton::draw ( Rect  clipRect  )  [virtual]

Draw the region of the button that falls within the clipRect.

Parameters:
clipRect The clipping region to draw within.

Reimplemented from WoopsiUI::Button.

Reimplemented in WoopsiUI::SkinnedScreenDepthButton, WoopsiUI::SkinnedScreenFlipButton, WoopsiUI::SkinnedWindowCloseButton, WoopsiUI::SkinnedWindowDepthButton, and WoopsiUI::WindowBorderButton.

bool DecorationGlyphButton::focus (  )  [virtual]

Give the gadget focus.

Returns:
True if the gadget received focus correctly.

Reimplemented from WoopsiUI::Gadget.


Member Data Documentation

Character to display when clicked

Character to display when unclicked


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations Enumerator

Generated on Sat Oct 24 14:33:10 2009 for Woopsi by  doxygen 1.6.1