$treeview $search $mathjax
Stratagus
2.2.7
$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 <textfield.h>
Public Member Functions | |
TextField () | |
TextField (const std::string &text) | |
virtual void | setText (const std::string &text) |
virtual const std::string & | getText () const |
virtual void | drawCaret (Graphics *graphics, int x) |
virtual void | adjustSize () |
virtual void | adjustHeight () |
virtual void | setCaretPosition (unsigned int position) |
virtual unsigned int | getCaretPosition () const |
virtual void | getTextSelectionPositions (unsigned int *first, unsigned int *len) |
Gets the currently selected text. | |
virtual void | fontChanged () |
virtual void | draw (Graphics *graphics) |
virtual void | drawBorder (Graphics *graphics) |
virtual void | mousePress (int x, int y, int button) |
virtual void | mouseMotion (int x, int y) |
virtual bool | keyPress (const Key &key) |
Protected Member Functions | |
void | fixScroll () |
Protected Attributes | |
std::string | mText |
int | mCaretPosition |
int | mXScroll |
int | mSelectStart |
int | mSelectEndOffset |
gcn::TextField::TextField | ( | ) |
Default constructor.
gcn::TextField::TextField | ( | const std::string & | text | ) |
Constructor. Initializes the textfield with a given string.
text | the initial text. |
void gcn::TextField::setText | ( | const std::string & | text | ) | [virtual] |
const std::string & gcn::TextField::getText | ( | ) | const [virtual] |
void gcn::TextField::drawCaret | ( | Graphics * | graphics, | |
int | x | |||
) | [virtual] |
Draws the caret (the little marker in the text that shows where the letters you type will appear). Easily overloaded if you want to change the style of the caret.
graphics | the Graphics object to draw with. | |
x | the caret's x-position. |
void gcn::TextField::adjustSize | ( | ) | [virtual] |
void gcn::TextField::adjustHeight | ( | ) | [virtual] |
Adjusts the height of the text field to fit the font size. The height of the TextField is initialized with this function by the constructors.
void gcn::TextField::setCaretPosition | ( | unsigned int | position | ) | [virtual] |
Sets the caret position.
position | the caret position. |
unsigned int gcn::TextField::getCaretPosition | ( | ) | const [virtual] |
Gets the caret position.
void gcn::TextField::getTextSelectionPositions | ( | unsigned int * | first, | |
unsigned int * | len | |||
) | [virtual] |
Gets the currently selected text.
void gcn::TextField::fontChanged | ( | ) | [virtual] |
Called when the font has changed. If the change is global, this function will only be called if the Widget don't have a font already set.
Reimplemented from gcn::Widget.
void gcn::TextField::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.
void gcn::TextField::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::TextField::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::TextField::mouseMotion | ( | int | , | |
int | ||||
) | [virtual] |
Called when the mouse moves and 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. |
Reimplemented from gcn::MouseListener.
bool gcn::TextField::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.
void gcn::TextField::fixScroll | ( | ) | [protected] |
Scrolls the text horizontally so that the caret shows if needed.
std::string gcn::TextField::mText [protected] |
int gcn::TextField::mCaretPosition [protected] |
int gcn::TextField::mXScroll [protected] |
int gcn::TextField::mSelectStart [protected] |
int gcn::TextField::mSelectEndOffset [protected] |