#include <textfield.h>

Inheritance diagram for gcn::TextField:

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	setPassword (bool flag)
	Set's the flag to make this a password field. More...

virtual void	getTextSelectionPositions (unsigned int first, unsigned int len)
	Gets the currently selected text. More...

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)

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)

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
void	fixScroll ()

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::string	mText

int	mCaretPosition

int	mXScroll

int	mSelectStart

int	mSelectEndOffset

bool	isPassword

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 text field in which you can write or display a line of text.

Constructor & Destructor Documentation

◆ TextField() [1/2]

gcn::TextField::TextField ( )

Default constructor.

◆ TextField() [2/2]

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

Constructor. Initializes the textfield with a given string.

Parameters

text	the initial text.

Member Function Documentation

◆ adjustHeight()

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.

◆ adjustSize()

void gcn::TextField::adjustSize ( )

virtual

Adjusts the size of the TextField to fit the font size. The constructor taking a string uses this function to initialize the size of the TextField.

◆ draw()

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.

Parameters

graphics a Graphics object to draw with.

Implements gcn::Widget.

Reimplemented in ImageTextField.

◆ drawBorder()

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.

Parameters

graphics a Graphics object to draw with.

Reimplemented from gcn::Widget.

Reimplemented in ImageTextField.

◆ drawCaret()

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.

Parameters

graphics	the Graphics object to draw with.
x	the caret's x-position.

◆ fixScroll()

void gcn::TextField::fixScroll ( )

protected

Scrolls the text horizontally so that the caret shows if needed.

◆ fontChanged()

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.

◆ getCaretPosition()

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

virtual

Gets the caret position.

Returns: the caret position.

◆ getText()

const std::string & gcn::TextField::getText ( ) const

virtual

Gets the text.

Returns: the text of the TextField.

◆ getTextSelectionPositions()

void gcn::TextField::getTextSelectionPositions	(	unsigned int *	first,
		unsigned int *	len
	)

virtual

Gets the currently selected text.

◆ keyPress()

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.

Parameters

key	the key pressed.

Reimplemented from gcn::KeyListener.

◆ mouseMotion()

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.

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.

Reimplemented from gcn::MouseListener.

◆ mousePress()

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.

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.

◆ setCaretPosition()

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

virtual

Sets the caret position.

Parameters

position the caret position.

◆ setPassword()

void gcn::TextField::setPassword ( bool flag )

virtual

Set's the flag to make this a password field.

◆ setText()

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

virtual

Sets the text.

Parameters

text	the new text in the TextField.

Member Data Documentation

◆ isPassword

bool gcn::TextField::isPassword

protected

◆ mCaretPosition

int gcn::TextField::mCaretPosition

protected

◆ mSelectEndOffset

int gcn::TextField::mSelectEndOffset

protected

◆ mSelectStart

int gcn::TextField::mSelectStart

protected

◆ mText

std::string gcn::TextField::mText

protected

◆ mXScroll

int gcn::TextField::mXScroll

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TextField() [1/2]

◆ TextField() [2/2]

Member Function Documentation

◆ adjustHeight()

◆ adjustSize()

◆ draw()

◆ drawBorder()

◆ drawCaret()

◆ fixScroll()

◆ fontChanged()

◆ getCaretPosition()

◆ getText()

◆ getTextSelectionPositions()

◆ keyPress()

◆ mouseMotion()

◆ mousePress()

◆ setCaretPosition()

◆ setPassword()

◆ setText()

Member Data Documentation

◆ isPassword

◆ mCaretPosition

◆ mSelectEndOffset

◆ mSelectStart

◆ mText

◆ mXScroll