#include <textbox.h>

Inheritance diagram for gcn::TextBox:

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)

Public Member Functions inherited from gcn::Widget
	Widget ()

virtual	~Widget ()

virtual void	logic ()

virtual BasicContainer *	getParent () const

virtual void	setWidth (int width)

virtual int	getWidth () const

virtual void	setHeight (int height)

virtual int	getHeight () const

virtual void	setSize (int width, int height)

virtual void	setX (int x)

virtual int	getX () const

virtual void	setY (int y)

virtual int	getY () const

virtual void	setPosition (int x, int y)

virtual void	setDimension (const Rectangle &dimension)

virtual void	setBorderSize (unsigned int borderSize)

virtual unsigned int	getBorderSize () const

virtual const Rectangle &	getDimension () const

virtual void	setFocusable (bool focusable)

virtual bool	isFocusable () const

virtual bool	hasFocus () const

virtual void	setEnabled (bool enabled)

virtual bool	isEnabled () const

virtual void	lostFocus ()

virtual void	gotFocus ()

virtual bool	hasMouse () const

virtual void	setVisible (bool visible)

virtual bool	isVisible () const

virtual void	setBaseColor (const Color &color)

virtual const Color &	getBaseColor () const

virtual void	setForegroundColor (const Color &color)

virtual const Color &	getForegroundColor () const

virtual void	setBackgroundColor (const Color &color)

virtual const Color &	getBackgroundColor () const

virtual void	setDisabledColor (const Color &color)

virtual const Color &	getDisabledColor () const

virtual void	_mouseInputMessage (const MouseInput &mouseInput)

virtual bool	_keyInputMessage (const KeyInput &keyInput)

virtual void	hotKeyPress ()

virtual void	hotKeyRelease ()

virtual void	_mouseInMessage ()

virtual void	_mouseOutMessage ()

virtual void	requestFocus ()

virtual void	requestMoveToTop ()

virtual void	requestMoveToBottom ()

virtual void	_setFocusHandler (FocusHandler *focusHandler)

virtual FocusHandler *	_getFocusHandler ()

virtual void	addActionListener (ActionListener *actionListener)

virtual void	removeActionListener (ActionListener *actionListener)

virtual void	addMouseListener (MouseListener *mouseListener)

virtual void	removeMouseListener (MouseListener *mouseListener)

virtual void	addKeyListener (KeyListener *keyListener)

virtual void	removeKeyListener (KeyListener *keyListener)

virtual void	setEventId (const std::string &eventId)

virtual const std::string &	getEventId () const

virtual void	getAbsolutePosition (int &x, int &y) const

virtual void	_setParent (BasicContainer *parent)

Font *	getFont () const

virtual void	setFont (Font *font)

virtual int	getHotKey () const

virtual void	setHotKey (const int key)

virtual void	setHotKey (const char *key)

virtual bool	isTabInEnabled () const

virtual void	setTabInEnabled (bool enabled)

virtual bool	isTabOutEnabled () const

virtual void	setTabOutEnabled (bool enabled)

virtual bool	isDragged () const

virtual void	requestModalFocus ()

virtual void	releaseModalFocus ()

virtual bool	hasModalFocus () const

virtual void	setDirty (bool dirty)

virtual bool	getDirty () const

Public Member Functions inherited from gcn::MouseListener
virtual	~MouseListener ()

virtual void	mouseIn ()

virtual void	mouseOut ()

virtual void	mouseRelease (int, int, int)

virtual void	mouseClick (int, int, int, int)

virtual void	mouseWheelUp (int, int)

virtual void	mouseWheelDown (int, int)

virtual void	mouseMotion (int, int)

Public Member Functions inherited from gcn::KeyListener
virtual	~KeyListener ()

virtual bool	keyRelease (const Key &)

virtual void	hotKeyPress (const Key &)

virtual void	hotKeyRelease (const Key &)

Protected Member Functions
virtual void	drawCaret (Graphics *graphics, int x, int y)

virtual void	adjustSize ()

Protected Member Functions inherited from gcn::Widget
void	generateAction ()

Protected Member Functions inherited from gcn::MouseListener
	MouseListener ()

Protected Member Functions inherited from gcn::KeyListener
	KeyListener ()

Protected Attributes
std::vector< std::string >	mTextRows

int	mCaretColumn

int	mCaretRow

bool	mEditable

bool	mOpaque

Protected Attributes inherited from gcn::Widget
MouseListenerList	mMouseListeners

KeyListenerList	mKeyListeners

ActionListenerList	mActionListeners

Color	mForegroundColor

Color	mBackgroundColor

Color	mBaseColor

Color	mDisabledColor

FocusHandler *	mFocusHandler

BasicContainer *	mParent

Rectangle	mDimension

unsigned int	mBorderSize

std::string	mEventId

int	mClickTimeStamp

int	mClickCount

int	mClickButton

bool	mHasMouse

bool	mFocusable

bool	mVisible

bool	mTabIn

bool	mTabOut

bool	mEnabled

Font *	mCurrentFont

int	mHotKey

bool	mDirty

Additional Inherited Members
Static Public Member Functions inherited from gcn::Widget
static void	setGlobalFont (Font *font)

static bool	widgetExists (const Widget *widget)

Protected Types inherited from gcn::Widget
typedef std::list< MouseListener * >	MouseListenerList

typedef MouseListenerList::iterator	MouseListenerIterator

typedef std::list< KeyListener * >	KeyListenerList

typedef KeyListenerList::iterator	KeyListenerIterator

typedef std::list< ActionListener * >	ActionListenerList

typedef ActionListenerList::iterator	ActionListenerIterator

Static Protected Attributes inherited from gcn::Widget
static DefaultFont	mDefaultFont

static Font *	mGlobalFont = NULL

static std::list< Widget * >	mWidgets

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

◆ TextBox() [1/2]

gcn::TextBox::TextBox ( )

Constructor.

◆ TextBox() [2/2]

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

Constructor.

Parameters

text	the text of the TextBox.

Member Function Documentation

◆ addRow()

void gcn::TextBox::addRow ( const std::string row )

virtual

Adds a text row to the text.

Parameters

row a row.

◆ adjustSize()

void gcn::TextBox::adjustSize ( )

protectedvirtual

Adjusts the TextBox size to fit the font size.

◆ draw()

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.

◆ drawBorder()

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.

◆ drawCaret()

void gcn::TextBox::drawCaret	(	Graphics *	graphics,
		int	x,
		int	y
	)

protectedvirtual

Draws the caret.

Parameters

graphics	a Graphics object to draw with.
x	the x position.
y	the y position.

◆ fontChanged()

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.

◆ getCaretColumn()

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.

◆ getCaretPosition()

unsigned int gcn::TextBox::getCaretPosition ( ) const

virtual

Gets the caret position in the text.

Returns: the caret position in the text.

◆ getCaretRow()

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.

◆ getNumberOfRows()

unsigned int gcn::TextBox::getNumberOfRows ( ) const

virtual

Gets the number of rows in the text.

Returns: the number of rows in the text.

◆ getText()

std::string gcn::TextBox::getText ( ) const

virtual

Gets the text.

Returns: the text of the TextBox.

◆ getTextRow()

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.

◆ isEditable()

bool gcn::TextBox::isEditable ( ) const

virtual

Checks if the TextBox is editable.

Returns: true it the TextBox is editable.

◆ isOpaque()

bool gcn::TextBox::isOpaque ( )

virtual

Checks if the TextBox is opaque

Returns: true if the TextBox is opaque

◆ keyPress()

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.

◆ mousePress()

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.

◆ scrollToCaret()

void gcn::TextBox::scrollToCaret ( )

virtual

Scrolls the text to the caret if the TextBox is in a ScrollArea.

◆ setCaretColumn()

void gcn::TextBox::setCaretColumn ( int column )

virtual

Sets the column the caret should be in in the text.

Parameters

column the column number.

◆ setCaretPosition()

void gcn::TextBox::setCaretPosition ( unsigned int position )

virtual

Sets the position of the caret in the text.

Parameters

position the positon of the caret.

◆ setCaretRow()

void gcn::TextBox::setCaretRow ( int row )

virtual

Sets the row the caret should be in in the text.

Parameters

row	the row number.

◆ setCaretRowColumn()

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.

◆ setEditable()

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.

◆ setOpaque()

void gcn::TextBox::setOpaque ( bool opaque )

virtual

Sets the TextBox to be opaque.

Parameters

opaque true if the TextBox should be opaque.

◆ setText()

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

virtual

Sets the text.

Parameters

text	the text of the TextBox.

◆ setTextRow()

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.

Member Data Documentation

◆ mCaretColumn

int gcn::TextBox::mCaretColumn

protected

◆ mCaretRow

int gcn::TextBox::mCaretRow

protected

◆ mEditable

bool gcn::TextBox::mEditable

protected

◆ mOpaque

bool gcn::TextBox::mOpaque

protected

◆ mTextRows

std::vector<std::string> gcn::TextBox::mTextRows

protected

The documentation for this class was generated from the following files:

src/guichan/include/guichan/widgets/textbox.h
src/guichan/widgets/textbox.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextBox() [1/2]

◆ TextBox() [2/2]

Member Function Documentation

◆ addRow()

◆ adjustSize()

◆ draw()

◆ drawBorder()

◆ drawCaret()

◆ fontChanged()

◆ getCaretColumn()

◆ getCaretPosition()

◆ getCaretRow()

◆ getNumberOfRows()

◆ getText()

◆ getTextRow()

◆ isEditable()

◆ isOpaque()

◆ keyPress()

◆ mousePress()

◆ scrollToCaret()

◆ setCaretColumn()

◆ setCaretPosition()

◆ setCaretRow()

◆ setCaretRowColumn()

◆ setEditable()

◆ setOpaque()

◆ setText()

◆ setTextRow()

Member Data Documentation

◆ mCaretColumn

◆ mCaretRow

◆ mEditable

◆ mOpaque

◆ mTextRows