$treeview $search $mathjax
Stratagus
2.2.6
$projectbrief
|
$projectbrief
|
$searchbox |
_________ __ __ / _____// |_____________ _/ |______ ____ __ __ ______ \_____ \\ __\_ __ \__ \\ __\__ \ / ___\| | \/ ___/ / \| | | | \// __ \| | / __ \_/ /_/ > | /\___ \ /_______ /|__| |__| (____ /__| (____ /\___ /|____//____ > \/ \/ \//_____/ \/ ______________________ ______________________ T H E W A R B E G I N S Stratagus - A free fantasy real time strategy game engine
#include <button.h>
Public Member Functions | |
Button () | |
Button (const std::string &caption) | |
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 | adjustSize () |
virtual bool | isPressed () const |
virtual void | draw (Graphics *graphics) |
virtual void | drawBorder (Graphics *graphics) |
virtual void | lostFocus () |
virtual void | hotKeyPress () |
virtual void | hotKeyRelease () |
virtual void | mouseClick (int x, int y, int button, int count) |
virtual void | mousePress (int x, int y, int button) |
virtual void | mouseRelease (int x, int y, int button) |
virtual bool | keyPress (const Key &key) |
virtual bool | keyRelease (const Key &key) |
Protected Attributes | |
std::string | mCaption |
bool | mMouseDown |
bool | mKeyDown |
bool | mHotKeyDown |
unsigned int | mAlignment |
NOTE: You can only have text (a caption) on the button. If you want it to handle, for instance images, you can implement an ImageButton of your own and overload member functions from Button.
gcn::Button::Button | ( | ) |
Constructor.
gcn::Button::Button | ( | const std::string & | caption | ) |
void gcn::Button::setCaption | ( | const std::string & | caption | ) | [virtual] |
const std::string & gcn::Button::getCaption | ( | ) | const [virtual] |
void gcn::Button::setAlignment | ( | unsigned int | alignment | ) | [virtual] |
Sets the alignment for the caption.
alignment | Graphics::LEFT, Graphics::CENTER or Graphics::RIGHT |
unsigned int gcn::Button::getAlignment | ( | ) | const [virtual] |
Gets the alignment for the caption.
void gcn::Button::adjustSize | ( | ) | [virtual] |
Adjusts the buttons size to fit the content.
Reimplemented in ImageButton.
bool gcn::Button::isPressed | ( | ) | const [virtual] |
Checks if the button is pressed down. Useful when drawing.
void gcn::Button::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.
graphics | a Graphics object to draw with. |
Implements gcn::Widget.
Reimplemented in ImageButton.
void gcn::Button::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.
graphics | a Graphics object to draw with. |
Reimplemented from gcn::Widget.
void gcn::Button::lostFocus | ( | ) | [virtual] |
Called if the Widget loses focus.
Reimplemented from gcn::Widget.
void gcn::Button::hotKeyPress | ( | ) | [virtual] |
Called when a Widget's hot key is pressed
Reimplemented from gcn::Widget.
void gcn::Button::hotKeyRelease | ( | ) | [virtual] |
Called when a Widget's hot key is released
Reimplemented from gcn::Widget.
void gcn::Button::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.
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.
void gcn::Button::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.
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.
void gcn::Button::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.
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.
bool gcn::Button::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.
key | the key pressed. |
Reimplemented from gcn::KeyListener.
bool gcn::Button::keyRelease | ( | const Key & | ) | [virtual] |
Called if a key is released when the widget has keyboard focus.
key | the key released. |
Reimplemented from gcn::KeyListener.
std::string gcn::Button::mCaption [protected] |
bool gcn::Button::mMouseDown [protected] |
bool gcn::Button::mKeyDown [protected] |
bool gcn::Button::mHotKeyDown [protected] |
unsigned int gcn::Button::mAlignment [protected] |