$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 <textbox.h>
Public Member Functions | |
TextBox () | |
TextBox (const std::string &text) | |
virtual void | setText (const std::string &text) |
virtual std::string | getText () const |
virtual const std::string & | getTextRow (int row) const |
virtual void | setTextRow (int row, const std::string &text) |
virtual unsigned int | getNumberOfRows () const |
virtual unsigned int | getCaretPosition () const |
virtual void | setCaretPosition (unsigned int position) |
virtual unsigned int | getCaretRow () const |
virtual void | setCaretRow (int row) |
virtual unsigned int | getCaretColumn () const |
virtual void | setCaretColumn (int column) |
virtual void | setCaretRowColumn (int row, int column) |
virtual void | scrollToCaret () |
virtual bool | isEditable () const |
virtual void | setEditable (bool editable) |
virtual void | addRow (const std::string row) |
virtual bool | isOpaque () |
virtual void | setOpaque (bool opaque) |
virtual void | draw (Graphics *graphics) |
virtual void | drawBorder (Graphics *graphics) |
virtual void | fontChanged () |
virtual bool | keyPress (const Key &key) |
virtual void | mousePress (int x, int y, int button) |
Protected Member Functions | |
virtual void | drawCaret (Graphics *graphics, int x, int y) |
virtual void | adjustSize () |
Protected Attributes | |
std::vector< std::string > | mTextRows |
int | mCaretColumn |
int | mCaretRow |
bool | mEditable |
bool | mOpaque |
NOTE: A plain TextBox is really uggly and looks much better inside a ScrollArea.
gcn::TextBox::TextBox | ( | ) |
Constructor.
gcn::TextBox::TextBox | ( | const std::string & | text | ) |
void gcn::TextBox::setText | ( | const std::string & | text | ) | [virtual] |
std::string gcn::TextBox::getText | ( | ) | const [virtual] |
Gets the text.
const std::string & gcn::TextBox::getTextRow | ( | int | row | ) | const [virtual] |
void gcn::TextBox::setTextRow | ( | int | row, | |
const std::string & | text | |||
) | [virtual] |
unsigned int gcn::TextBox::getNumberOfRows | ( | ) | const [virtual] |
Gets the number of rows in the text.
unsigned int gcn::TextBox::getCaretPosition | ( | ) | const [virtual] |
Gets the caret position in the text.
void gcn::TextBox::setCaretPosition | ( | unsigned int | position | ) | [virtual] |
Sets the position of the caret in the text.
position | the positon of the caret. |
unsigned int gcn::TextBox::getCaretRow | ( | ) | const [virtual] |
Gets the row the caret is in in the text.
void gcn::TextBox::setCaretRow | ( | int | row | ) | [virtual] |
Sets the row the caret should be in in the text.
row | the row number. |
unsigned int gcn::TextBox::getCaretColumn | ( | ) | const [virtual] |
Gets the column the caret is in in the text.
void gcn::TextBox::setCaretColumn | ( | int | column | ) | [virtual] |
Sets the column the caret should be in in the text.
column | the column number. |
void gcn::TextBox::setCaretRowColumn | ( | int | row, | |
int | column | |||
) | [virtual] |
Sets the row and the column the caret should be in in the text.
row | the row number. | |
column | the column number. |
void gcn::TextBox::scrollToCaret | ( | ) | [virtual] |
Scrolls the text to the caret if the TextBox is in a ScrollArea.
bool gcn::TextBox::isEditable | ( | ) | const [virtual] |
void gcn::TextBox::setEditable | ( | bool | editable | ) | [virtual] |
void gcn::TextBox::addRow | ( | const std::string | row | ) | [virtual] |
Adds a text row to the text.
row | a row. |
bool gcn::TextBox::isOpaque | ( | ) | [virtual] |
void gcn::TextBox::setOpaque | ( | bool | opaque | ) | [virtual] |
void gcn::TextBox::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::TextBox::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::TextBox::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.
bool gcn::TextBox::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::TextBox::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::TextBox::drawCaret | ( | Graphics * | graphics, | |
int | x, | |||
int | y | |||
) | [protected, virtual] |
Draws the caret.
graphics | a Graphics object to draw with. | |
x | the x position. | |
y | the y position. |
void gcn::TextBox::adjustSize | ( | ) | [protected, virtual] |
Adjusts the TextBox size to fit the font size.
std::vector<std::string> gcn::TextBox::mTextRows [protected] |
int gcn::TextBox::mCaretColumn [protected] |
int gcn::TextBox::mCaretRow [protected] |
bool gcn::TextBox::mEditable [protected] |
bool gcn::TextBox::mOpaque [protected] |