An edit box widget/. More...

#include <pawstextbox.h>

Classes
struct	Word
	struct to contain the end boundry of a word and it's spellcheck status More...
Public Member Functions
void	Clear ()
virtual void	Draw ()
	Draws the widget and all of it's children.
virtual int	GetBorderStyle ()
	This returns the BORDER_BUMP style.
virtual bool	GetFocusOverridesControls () const
	Test if the widget should intercept all key presses.
unsigned int	GetMaxLength () const
	Returns the max length for the text box.
unsigned int	GetRemainingChars () const
	Gets the remaining characters that can be input.
bool	getSpellChecked () const
	returns if the spellchecker is used in this widget
const char *	GetText ()
unsigned int	GetTopLine ()
	Set & Get top line funcs.
unsigned int	getTypoColour ()
	Method the get the current colour used for typos.
virtual bool	OnClipboard (const csString &content)
	Called as a callback to a request for clipboard content if avaliabe.
bool	OnKeyDown (utf32_char code, utf32_char key, int modifiers)
	Process keydown messages.
virtual bool	OnMouseDown (int button, int modifiers, int x, int y)
	Manage mouse down event to test for and apply window changes.
virtual void	OnUpdateData (const char *dataname, PAWSData &data)
	pawsEditTextBox ()
	pawsEditTextBox (const pawsEditTextBox &origin)
bool	SelfPopulate (iDocumentNode *node)
	This function allows a widget to fill in its own contents from an xml node supplied.
void	SetCursorPosition (size_t pos)
void	SetMaxLength (unsigned int maxlen)
	Sets the max length for the text box.
void	SetMultiline (bool multi)
void	SetPassword (bool pass)
void	SetSizeByText ()
	Sets size of the widget to fit the text that it displays.
void	setSpellChecked (const bool check)
	set if the spellchecker should be used
void	SetText (const char *text, bool publish=true)
	Change the text in the edit box.
void	SetTopLine (unsigned int newTopLine)
void	setTypoColour (unsigned int col)
	Method to set the colour used for typos.
bool	Setup (iDocumentNode *node)
	Setup this widget.
void	toggleSpellChecked ()
	toggels the current setting of the spellchecker
virtual	~pawsEditTextBox ()
Protected Member Functions
void	checkSpelling ()
	Helper method that does the actual spellchecking.
Protected Attributes
bool	blink
	The current blink status.
csTicks	blinkTicks
	Keep track of ticks for flashing.
csRef< iVirtualClock >	clock
unsigned int	cursorLine
size_t	cursorPosition
	The position of the cursor blink (in code units not points)
int	lineHeight
unsigned int	maxLen
	The maximum length the text is allowed to be.
size_t	maxLines
bool	multiLine
bool	password
bool	spellChecked
	Should the text be checked by the spellchecker plugin (if available)
csRef< iSpellChecker >	spellChecker
	PS spellChecker plugin.
int	start
	Position of first character that we display.
csString	text
	Current input line.
unsigned int	topLine
unsigned int	typoColour
	Colour used for typos.
size_t	usedLines
pawsScrollBar *	vScrollBar
csArray< Word >	words
	Array that contains the boundries of the words and if the spellchecker recognizes them or not.

Detailed Description

An edit box widget/.

Definition at line 409 of file pawstextbox.h.

Constructor & Destructor Documentation

pawsEditTextBox::pawsEditTextBox ( )

virtual pawsEditTextBox::~pawsEditTextBox ( ) [virtual]

pawsEditTextBox::pawsEditTextBox ( const pawsEditTextBox & origin )

Member Function Documentation

void pawsEditTextBox::checkSpelling ( ) [protected]

Helper method that does the actual spellchecking.

Called from OnKeyDown

void pawsEditTextBox::Clear ( )

virtual void pawsEditTextBox::Draw ( ) [virtual]

Draws the widget and all of it's children.

Remarks:: Uses clipping rect of it's parent to define drawing area. If the drawing area defined is empty it returns.

Reimplemented from pawsWidget.

virtual int pawsEditTextBox::GetBorderStyle ( ) [inline, virtual]

This returns the BORDER_BUMP style.

Remarks:: Other styles available include: BORDER_RAISED, BORDER_SUNKEN and BORDER_ETCHED.

Reimplemented from pawsWidget.

Definition at line 456 of file pawstextbox.h.

virtual bool pawsEditTextBox::GetFocusOverridesControls ( ) const [inline, virtual]

Test if the widget should intercept all key presses.

Remarks:: False by default, should be true for text entry widgets

Reimplemented from pawsWidget.

Definition at line 485 of file pawstextbox.h.

unsigned int pawsEditTextBox::GetMaxLength ( ) const [inline]

Returns the max length for the text box.

Returns:: maxLen

Definition at line 499 of file pawstextbox.h.

unsigned int pawsEditTextBox::GetRemainingChars ( ) const [inline]

Gets the remaining characters that can be input.

Returns:: Remaining characters or UINT_MAX if no max length specified

Definition at line 507 of file pawstextbox.h.

bool pawsEditTextBox::getSpellChecked ( ) const [inline]

returns if the spellchecker is used in this widget

Definition at line 516 of file pawstextbox.h.

const char* pawsEditTextBox::GetText ( ) [inline]

Definition at line 422 of file pawstextbox.h.

unsigned int pawsEditTextBox::GetTopLine ( ) [inline]

Set & Get top line funcs.

Definition at line 471 of file pawstextbox.h.

unsigned int pawsEditTextBox::getTypoColour ( ) [inline]

Method the get the current colour used for typos.

Definition at line 537 of file pawstextbox.h.

virtual bool pawsEditTextBox::OnClipboard ( const csString & content ) [virtual]

Called as a callback to a request for clipboard content if avaliabe.

Note:: Only implemented for unix

Reimplemented from pawsWidget.

bool pawsEditTextBox::OnKeyDown	(	utf32_char	keyCode,
		utf32_char	keyChar,
		int	modifiers
	)		`[virtual]`

Process keydown messages.

Parameters:

keyCode	The code for the pressed key.
keyChar	The key pressed.
modifiers	Used to modify tab behavior.

Returns:: bool TRUE for success FALSE if no action.

Remarks:: If you override this, be sure to also override GetFocusOverridesControls() as returning true

Reimplemented from pawsWidget.

virtual bool pawsEditTextBox::OnMouseDown	(	int	button,
		int	modifiers,
		int	x,
		int	y
	)		`[virtual]`

Manage mouse down event to test for and apply window changes.

Parameters:

button	Type of button: 1 resizable or movable, 2 context menu or config window.
modifiers	Used with PAWS_CONSTRUCTION.
x	Used to test for resize.
y	Used to test for resize.