$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

gcn::TextBox Class Reference

#include <textbox.h>

Inheritance diagram for gcn::TextBox:

gcn::Widget gcn::MouseListener gcn::KeyListener

List of all members.


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

Detailed Description

A TextBox in which you can write and/or display a lines of text.

NOTE: A plain TextBox is really uggly and looks much better inside a ScrollArea.


Constructor & Destructor Documentation

gcn::TextBox::TextBox (  ) 

Constructor.

gcn::TextBox::TextBox ( const std::string &  text  ) 

Constructor.

Parameters:
text the text of the TextBox.


Member Function Documentation

void gcn::TextBox::setText ( const std::string &  text  )  [virtual]

Sets the text.

Parameters:
text the text of the TextBox.

std::string gcn::TextBox::getText (  )  const [virtual]

Gets the text.

Returns:
the text of the TextBox.

const std::string & gcn::TextBox::getTextRow ( int  row  )  const [virtual]

Gets the row of a text.

Returns:
the text of a certain row in the TextBox.

void gcn::TextBox::setTextRow ( int  row,
const std::string &  text 
) [virtual]

Sets the text of a certain row in a TextBox.

Parameters:
row the row number.
text the text of a certain row in the TextBox.

unsigned int gcn::TextBox::getNumberOfRows (  )  const [virtual]

Gets the number of rows in the text.

Returns:
the number of rows in the text.

unsigned int gcn::TextBox::getCaretPosition (  )  const [virtual]

Gets the caret position in the text.

Returns:
the caret position in the text.

void gcn::TextBox::setCaretPosition ( unsigned int  position  )  [virtual]

Sets the position of the caret in the text.

Parameters:
position the positon of the caret.

unsigned int gcn::TextBox::getCaretRow (  )  const [virtual]

Gets the row the caret is in in the text.

Returns:
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.

Parameters:
row the row number.

unsigned int gcn::TextBox::getCaretColumn (  )  const [virtual]

Gets the column the caret is in in the text.

Returns:
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.

Parameters:
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.

Parameters:
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]

Checks if the TextBox is editable.

Returns:
true it the TextBox is editable.

void gcn::TextBox::setEditable ( bool  editable  )  [virtual]

Sets if the TextBox should be editable or not.

Parameters:
editable true if the TextBox should be editable.

void gcn::TextBox::addRow ( const std::string  row  )  [virtual]

Adds a text row to the text.

Parameters:
row a row.

bool gcn::TextBox::isOpaque (  )  [virtual]

Checks if the TextBox is opaque

Returns:
true if the TextBox is opaque

void gcn::TextBox::setOpaque ( bool  opaque  )  [virtual]

Sets the TextBox to be opaque.

Parameters:
opaque true if the TextBox should be opaque.

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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.

Parameters:
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.


Member Data Documentation

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]


The documentation for this class was generated from the following files:
(C) Copyright 1998-2012 by The Stratagus Project under the GNU General Public License.
All trademarks and copyrights on this page are owned by their respective owners.