aedTextBox Class Reference

This class implements the textbox widget. More...

#include <aedTextBox.h>

Inheritance diagram for aedTextBox:

[legend]Collaboration diagram for aedTextBox:

[legend]List of all members.

Public Member Functions
	aedTextBox ()
virtual	~aedTextBox ()
virtual int	wm_update (Uint32 msdelta)
virtual int	wm_lbuttondown (Uint16 x, Uint16 y)
virtual int	wm_lbuttonup (Uint16 x, Uint16 y)
virtual int	wm_mousemove (Uint16 x, Uint16 y, Uint16 dx, Uint16 dy)
virtual int	wm_mouseleave ()
virtual int	wm_keydown (aedKeyEvent &event)
virtual void	render ()
virtual void	setReadOnly (bool state)
	Toggle textbox's read only property.
virtual bool	getReadOnly (void) const
virtual void	setBlinkInterval (Uint32 interval)
	Set caret's blinking interval.
bool	getPasswordMode () const
void	setPasswordMode (bool enable)
	Enable/disable password mode.
void	setCharMask (std::string mask)
	Set the string of characters to be ignored when processing keyboard events.
std::string	getCharMask ()
void	setSelection (Uint32 start, Uint32 end)
void	setSelectionStart (Uint32 start)
void	setSelectionEnd (Uint32 end)
int	calculateCaretPosition (Uint16 x, Uint16 y)
Protected Attributes
Uint16	m_CaretPos
bool	m_Selecting
Uint32	m_SelectionStart
Uint32	m_SelectionEnd
Uint32	m_BlinkInterval
Uint32	m_TimeSinceLastUpdate
int	m_StartPixel
bool	m_ShowCaret
bool	m_PasswordMode
std::string	m_CharMask

---

Detailed Description

This class implements the textbox widget.

---

Constructor & Destructor Documentation

aedTextBox::aedTextBox

(

)

virtual aedTextBox::~aedTextBox

(

)

[virtual]

---

Member Function Documentation

int aedTextBox::calculateCaretPosition	(	Uint16	x,
		Uint16	y
	)

std::string aedTextBox::getCharMask

(

)

[inline]

bool aedTextBox::getPasswordMode

(

)

const [inline]

virtual bool aedTextBox::getReadOnly

(

void

)

const [inline, virtual]

virtual void aedTextBox::render

(

)

[virtual]

Reimplemented from aedStaticText.

virtual void aedTextBox::setBlinkInterval

(

Uint32

interval

)

[inline, virtual]

Set caret's blinking interval.

Parameters:

interval

time interval in milliseconds (0 disables blinking)

void aedTextBox::setCharMask

(

std::string

mask

)

[inline]

Set the string of characters to be ignored when processing keyboard events.

void aedTextBox::setPasswordMode

(

bool

enable

)

[inline]

Enable/disable password mode.

virtual void aedTextBox::setReadOnly

(

bool

state

)

[inline, virtual]

Toggle textbox's read only property.

void aedTextBox::setSelection	(	Uint32	start,
		Uint32	end
	)			[inline]

void aedTextBox::setSelectionEnd

(

Uint32

end

)

[inline]

void aedTextBox::setSelectionStart

(

Uint32

start

)

[inline]

virtual int aedTextBox::wm_keydown

(

aedKeyEvent &

event

)

[virtual]

Reimplemented from aedWidget.

virtual int aedTextBox::wm_lbuttondown	(	Uint16	x,
		Uint16	y
	)			[virtual]

Reimplemented from aedWidget.

virtual int aedTextBox::wm_lbuttonup	(	Uint16	x,
		Uint16	y
	)			[virtual]

Reimplemented from aedWidget.

virtual int aedTextBox::wm_mouseleave

(

)

[virtual]

Reimplemented from aedWidget.

virtual int aedTextBox::wm_mousemove	(	Uint16	x,
		Uint16	y,
		Uint16	dx,
		Uint16	dy
	)			[virtual]

Reimplemented from aedWidget.

virtual int aedTextBox::wm_update

(

Uint32

msdelta

)

[virtual]

Reimplemented from aedWidget.

---

Member Data Documentation

Uint32 aedTextBox::m_BlinkInterval [protected]

Uint16 aedTextBox::m_CaretPos [protected]

std::string aedTextBox::m_CharMask [protected]

bool aedTextBox::m_PasswordMode [protected]

bool aedTextBox::m_Selecting [protected]

Uint32 aedTextBox::m_SelectionEnd [protected]

Uint32 aedTextBox::m_SelectionStart [protected]

bool aedTextBox::m_ShowCaret [protected]

int aedTextBox::m_StartPixel [protected]

Uint32 aedTextBox::m_TimeSinceLastUpdate [protected]

---

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

• aedGUI/include/aedTextBox.h

---