SmartWin++: WidgetTextBox Class Template Reference

List of all members.


Public Types
typedef bool(*)	boolFunctionTakingInt (EventHandlerClass , TextBoxType::TextBoxType , int)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and an int returning bool.
typedef bool(*)	boolFunctionTakingTstring (EventHandlerClass , TextBoxType::TextBoxType , const SmartUtil::tstring &)
	Typedef of a static/global function taking a pointer to the original class and a pointer to the this Widget class and a const SmartUtil::tstring & returning bool.
typedef bool(*)	boolFunctionTakingUnsigned (EventHandlerClass , TextBoxType::TextBoxType , unsigned)
	Typedef of a static/global function taking a pointer to the original class and a pointer to the this Widget class pluss an unsigned int returning void.
typedef bool(*)	boolValidationFunc (EventHandlerClass , TextBoxType::TextBoxType , unsigned, unsigned, SmartUtil::tstring &)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class, two unsigned int and a SmartUtil::tstring & returning bool.
typedef BrushPtr(*)	brushFunctionTakingCanvas (EventHandlerClass , TextBoxType::TextBoxType , Canvas &canvas)
	Typedef of a static/global function taking a pointer to the original class and a pointer to the this Widget class and a Canvas & returning BrushPtr.
typedef HRESULT(*)	hresultFunctionTakingLparamWparam (EventHandlerClass , TextBoxType::TextBoxType , LPARAM, WPARAM)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget, an LPARAM and a WPARAM returning HRESULT.
typedef int(*)	intCallbackCompareFunc (EventHandlerClass , TextBoxType::TextBoxType , LPARAM, LPARAM)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and two LPARAM returning int.
typedef bool(EventHandlerClass::*)	itsBoolFunctionTakingInt (TextBoxType::TextBoxType *, int)
	Typedef of a member function to the original class taking pointer to the this Widget and an int returning bool.
typedef bool(EventHandlerClass::*)	itsBoolFunctionTakingTstring (TextBoxType::TextBoxType *, const SmartUtil::tstring &)
	Typedef of a member function to the original class taking pointer to the this Widget and a const SmartUtil::tstring & returning bool.
typedef bool(EventHandlerClass::*)	itsBoolFunctionTakingUnsigned (TextBoxType::TextBoxType *, unsigned)
	Typedef of a member function to the original class taking pointer to the this Widget and unsigned and returning bool.
typedef bool(EventHandlerClass::*)	itsBoolValidationFunc (TextBoxType::TextBoxType *, unsigned, unsigned, SmartUtil::tstring &)
	Typedef of a member function to the original class taking pointer to the this Widget, two unsigned int and SmartUtil::tstring & returning bool.
typedef BrushPtr(EventHandlerClass::*)	itsBrushFunctionTakingCanvas (TextBoxType::TextBoxType *, Canvas &)
	Typedef of a member function to the original class taking pointer to the this Widget and a Canvas & returning BrushPtr.
typedef HRESULT(EventHandlerClass::*)	itsHresultFunctionTakingLparamWparam (TextBoxType::TextBoxType *, LPARAM, WPARAM)
	Typedef of a member function to the original class taking pointer to the this Widget, an LPARAM and a WPARAM returning HRESULT.
typedef int(EventHandlerClass::*)	itsIntLparamLparam (TextBoxType::TextBoxType *, LPARAM, LPARAM)
	Typedef of a member function to the original class taking pointer to the this Widget, two LPARAM returning int.
typedef void(EventHandlerClass::*)	itsVoidDrawItemFunction (TextBoxType::TextBoxType *, const DRAWITEMSTRUCT &)
	Typedef of a member function to the original class taking pointer to the this Widget and a const DRAWITEMSTRUCT & returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTaking2Bool (TextBoxType::TextBoxType *, bool, bool)
	Typedef of a member function to the original class taking pointer to the this Widget and two bool returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingBool (TextBoxType::TextBoxType *, bool)
	Typedef of a member function to the original class taking pointer to the this Widget and a bool returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingCanvas (TextBoxType::TextBoxType *, Canvas &)
	Typedef of a member function to the original class taking pointer to the this Widget and a Canvas & returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingConstString (TextBoxType::TextBoxType *, const SmartUtil::tstring &)
	Typedef of a member function to the original class taking pointer to the this Widget and a SmartUtil::tstring & returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingInt (TextBoxType::TextBoxType *, int)
	Typedef of a member function to the original class taking pointer to the this Widget and an int returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingMouseEventResult (TextBoxType::TextBoxType *, const MouseEventResult &)
	Typedef of a member function to the original class taking pointer to the this Widget and a const MouseEventResult & returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingPoint (TextBoxType::TextBoxType *, const Point &)
	Typedef of a member function to the original class taking pointer to the this Widget and const Point & returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingString (TextBoxType::TextBoxType *, SmartUtil::tstring &)
	Typedef of a member function to the original class taking pointer to the this Widget and a SmartUtil::tstring & returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingSystemTime (TextBoxType::TextBoxType *, const SYSTEMTIME &)
	Typedef of a member function to the original class taking pointer to the this Widget and a const SYSTEMTIME & returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingUInt (TextBoxType::TextBoxType *, unsigned)
	Typedef of a member function to the original class taking pointer to the this Widget and an unsigned int returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingVoid (TextBoxType::TextBoxType *)
	Typedef of a member function to the original class taking pointer to the this Widget returning void.
typedef void(EventHandlerClass::*)	itsVoidFunctionTakingWindowSizedEventResult (TextBoxType::TextBoxType *, const WidgetSizedEventResult &)
	Typedef of a member function to the original class taking pointer to the this Widget and const WidgetSizedEventResult & returning void.
typedef void(EventHandlerClass::*)	itsVoidGetIconFunc (TextBoxType::TextBoxType *, LPARAM, unsigned, int &)
	Typedef of a member function to the original class taking pointer to the this Widget, an unsigned int and an int & returning void.
typedef void(EventHandlerClass::*)	itsVoidGetItemFunc (TextBoxType::TextBoxType *, LPARAM, unsigned, unsigned, SmartUtil::tstring &)
	Typedef of a member function to the original class taking pointer to the this Widget, two unsigned int and SmartUtil::tstring & returning void.
typedef void(EventHandlerClass::*)	itsVoidMeasureItemFunction (TextBoxType::TextBoxType , MEASUREITEMSTRUCT )
	Typedef of a member function to the original class taking pointer to the this Widget and a MEASUREITEMSTRUCT * returning void.
typedef void(EventHandlerClass::*)	itsVoidUnsignedUnsignedBoolCanvasRectangle (TextBoxType::TextBoxType *, unsigned, unsigned, bool, Canvas &, const SmartWin::Rectangle &)
	Typedef of a member function to the original class taking pointer to the this Widget, two unsigned int, a Canvas & and a const Rectangle & returning void.
typedef WidgetTextBox< EventHandlerClass, MessageMapPolicy, TextBoxType > *	ObjectType
	Object type.
typedef WidgetTextBox< EventHandlerClass, MessageMapPolicy, TextBoxType >	ThisType
	Class type.
typedef void(*)	voidDrawItemFunction (EventHandlerClass , TextBoxType::TextBoxType , const DRAWITEMSTRUCT &)
	Typedef of a static/global function taking a pointer to the original class and a pointer to the this Widget class and a const DRAWITEMSTRUCT & returning void.
typedef void(*)	voidFunctionTaking2Bool (EventHandlerClass , TextBoxType::TextBoxType , bool, bool)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and two bool returning void.
typedef void(*)	voidFunctionTakingBool (EventHandlerClass , TextBoxType::TextBoxType , bool)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and a bool returning void.
typedef void(*)	voidFunctionTakingCanvas (EventHandlerClass , TextBoxType::TextBoxType , Canvas &)
	Typedef of a static/global function taking a pointer to the original class and a pointer to the this Widget class and a Canvas & returning void.
typedef void(*)	voidFunctionTakingConstString (EventHandlerClass , TextBoxType::TextBoxType , const SmartUtil::tstring &)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and a SmartUtil::tstring & returning void.
typedef void(*)	voidFunctionTakingInt (EventHandlerClass , TextBoxType::TextBoxType , int)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and an int returning void.
typedef void(*)	voidFunctionTakingMouseEventResult (EventHandlerClass , TextBoxType::TextBoxType , const MouseEventResult &)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and a const MouseEventResult & returning void.
typedef void(*)	voidFunctionTakingPoint (EventHandlerClass , TextBoxType::TextBoxType , const Point &)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and a const Point & returning void.
typedef void(*)	voidFunctionTakingString (EventHandlerClass , TextBoxType::TextBoxType , SmartUtil::tstring &)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and a SmartUtil::tstring & returning void.
typedef void(*)	voidFunctionTakingSystemTime (EventHandlerClass , TextBoxType::TextBoxType , const SYSTEMTIME &)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and a const SYSTEMTIME & returning void.
typedef void(*)	voidFunctionTakingUInt (EventHandlerClass , TextBoxType::TextBoxType , unsigned)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and an unsigned int returning void.
typedef void(*)	voidFunctionTakingVoid (EventHandlerClass , TextBoxType::TextBoxType )
	Typedef of a static/global function taking a pointer to the original class and a pointer to the this Widget class returning void.
typedef void(*)	voidFunctionTakingWindowSizedEventResult (EventHandlerClass , TextBoxType::TextBoxType , const WidgetSizedEventResult &)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class and a const WidgetSizedEventResult & returning void.
typedef void(*)	voidGetIconFunc (EventHandlerClass , TextBoxType::TextBoxType , LPARAM, unsigned, int &)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class, an LPARAM, an unsigned int and an int & returning void.
typedef void(*)	voidGetItemFunc (EventHandlerClass , TextBoxType::TextBoxType , LPARAM, unsigned, unsigned, int &)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class, an LPARAM, two unsigned int and a SmartUtil::tstring & returning void.
typedef void(*)	voidMeasureItemFunction (EventHandlerClass , TextBoxType::TextBoxType , MEASUREITEMSTRUCT *)
	Typedef of a static/global function taking a pointer to the original class and a pointer to the this Widget class and a MEASUREITEMSTRUCT * returning void.
typedef void(*)	voidUnsignedUnsignedBoolCanvasRectangle (EventHandlerClass , TextBoxType::TextBoxType , unsigned, unsigned, bool, Canvas &, const SmartWin::Rectangle &)
	Typedef of a static/global function taking a pointer to the original class, a pointer to the this Widget class, two unsigned int, a bool, a Canvas & and a const Rectangle & returning void.
Public Member Functions
void	addRemoveExStyle (DWORD addStyle, bool add)
	Use this function to add or remove windows exStyles.
void	addRemoveStyle (DWORD addStyle, bool add)
	Use this function to add or remove windows styles.
void	bringToBottom ()
	Brings the widget to the bottom.
void	bringToFront ()
	Brings the widget to the front.
virtual void	create (const Seed &cs=getDefaultSeed())
	Actually creates the TextBox.
long	findText (const SmartUtil::tstring &txt, unsigned offset=0) const
	Finds the given text in the text field and returns true if successfully.
Rectangle	getBounds () const
	Returns the position and size of the window.
bool	getCapsLockOn ()
	Checks if Caps Lock is on.
long	getCaretPos ()
	Returns the position of the caret.
Point	getClientAreaSize () const
	Returns the size of the client area of the window.
bool	getControlPressed ()
	Checks if control is pressed.
Utilities::CriticalSection &	getCriticalSection ()
	Returns a CriticalSection associated with the current Widget object.
HMENU	getCtrlId () const
	Returns the control id of the Widget.
bool	getEnabled () const
	Retrieves the enabled property of the Widget.
bool	getFocus () const
	Retrieves the focus property of the Widget.
FontPtr	getFont ()
	Returns the font used by the Widget.
Widget *	getParent () const
	Returns the parent Widget of the Widget.
Point	getPosition () const
	Returns the position of the window.
SmartUtil::tstring	getSelection () const
	Returns the current selected text from the text box.
bool	getShiftPressed ()
	Checks if shift is pressed.
Point	getSize () const
	Returns the size of the window.
SmartUtil::tstring	getText () const
	Gets the text of the AspectText realizing class.
DWORD	getTextLimit () const
	Returns the maximum number of characters that can be entered.
Point	getTextSize (const SmartUtil::tstring &text)
	Fills a Point with the size of text to be drawn in the Widget's font.
bool	getVisible () const
	Retrieves the visible property of the Widget.
HWND	handle () const
	Returns the HWND to the Widget.
void	invalidateWidget ()
	Add this widget to the update area.
void	maximize ()
	Maximize your window.
void	minimize ()
	Minimize your window.
void	onBackgroundColor (typename MessageMapType::itsBrushFunctionTakingCanvas eventHandler)
	Setting the event handler for the "erase background" event.
void	onChar (typename MessageMapType::itsBoolFunctionTakingInt eventHandler)
	Setting the event handler for the "char" event.
void	onEnabled (typename MessageMapType::itsVoidFunctionTakingBool eventHandler)
	Setting the event handler for the "enabled" event.
void	onFocus (typename MessageMapType::itsVoidFunctionTakingVoid eventHandler)
	Sets the event handler for what function to be called when control loses focus.
void	onKeyPressed (typename MessageMapType::itsBoolFunctionTakingInt eventHandler)
	Setting the event handler for the "key pressed" event.
void	onKillFocus (typename MessageMapType::itsVoidFunctionTakingVoid eventHandler)
	Sets the event handler for what function to be called when control loses focus.
void	onMoved (typename MessageMapType::itsVoidFunctionTakingPoint eventHandler)
void	onRaw (typename MessageMapType::itsHresultFunctionTakingLparamWparam eventHandler, const Message &msg)
	Setting the member event handler for a "raw" event.
void	onSized (typename MessageMapType::itsVoidFunctionTakingWindowSizedEventResult eventHandler)
void	onTextChanging (typename MessageMapType::itsVoidFunctionTakingConstString eventHandler)
	Setting the event handler for the "setText" event.
void	onUpdate (typename MessageMapType::itsVoidFunctionTakingVoid eventHandler)
	Sets the event handler for the Updated event.
void	onVisibilityChanged (typename MessageMapType::itsVoidFunctionTakingBool eventHandler)
	Setting the event handler for the "visible" event.
void	replaceSelection (const SmartUtil::tstring &txt, bool canUndo=true)
	Replaces the currently selected text in the text box with the given text parameter.
void	restore ()
	Restores your window.
virtual LRESULT	sendWidgetMessage (HWND hWnd, UINT msg, WPARAM &wPar, LPARAM &lPar)
	Send a message to the Widget.
void	setBorder (bool value=true)
	Adds (or removes) a border surrounding the control.
void	setBounds (int x, int y, int width, int height, bool updateWindow=true)
	Sets the new size and position of the window.
void	setBounds (const Point &newPos, const Point &newSize, bool updateWindow=true)
	Sets the new size and position of the window.
void	setBounds (const Rectangle &rect, bool updateWindow=true)
	Sets the new size and position of the window.
void	setEnabled (bool enabled)
	Sets the enabled property of the Widget.
void	setFocus ()
	Gives the Widget the keyboard focus.
void	setFont (PredefinedFontTypes stockObjectFont, bool forceUpdate=true)
	Function taking a PredefinedFontTypes type.
void	setFont (FontPtr font, bool forceUpdate=true)
	Sets the font used by the Widget.
void	setLowerCase (bool value=true)
	Adds (or removes) lower case forcing.
void	setNumbersOnly (bool value=true)
	Adds (or removes) the numbers property.
void	setPassword (bool value=true, TCHAR pwdChar= '*')
	Adds (or removes) the password property.
void	setPositionPerPlace (SmartWin::Place &bound)
	Given a bounding Place class, place this Widget and adjust to the next position.
void	setRaisedBorder (bool value=true)
	Set or remove the raised border (like in buttons).
void	setReadOnly (bool value=true)
	Adds (or removes) the readonly property.
void	setScrollBarHorizontally (bool value=true)
	Adds (or removes) the control horizontal scroll bars.
void	setScrollBarVertically (bool value=true)
	Adds (or removes) the control vertical scroll bars.
void	setSelection (long start=0, long end=-1)
	Sets the current selection of the Edit Control.
void	setSizeAsCol (const Rectangle &rect, int rows, int rownum, int border=0, bool updateWindow=true)
	Given a bounding rectangle with rows, put this Widget in the rownum position.
void	setSizeAsGridPerPlace (SmartWin::Place &bound, int rows, int cols)
	this Widget in the next cell.
void	setSizeAsRow (const Rectangle &rect, int cols, int colnum, int border=0, bool updateWindow=true)
	Given a bounding rectangle with cols, put this Widget in the colnum position.
void	setSizePerTextPerPlace (SmartWin::Place &bound, const SmartUtil::tstring &text, int extraX=0, int extraY=0)
	Place after sizing for the Widget's text, and adjust to the next position.
void	setSmoothSunkenBorder (bool value=true)
	Set or remove the smooth sunken border (generally used in read only text boxes).
void	setSunkenBorder (bool value=true)
	Set or remove the sunken border (like in text box widgets).
void	setText (const SmartUtil::tstring &txt)
	Sets the text of the AspectText realizing class.
void	setTextLimit (DWORD maxChars)
	Set the maximum number of characters that can be entered.
void	setUpperCase (bool value=true)
	Adds (or removes) upper case forcing.
void	setVisible (bool visible)
	Sets the visibility property of the Widget.
void	showCaret ()
	Call this function to scroll the caret into view.
virtual void	subclass (unsigned id)
	Subclasses the dialog item with the given dialog item id.
void	updateWidget ()
	Repaints the whole window.
Static Public Member Functions
static const Seed &	getDefaultSeed ()
	Default values for creation.
static Point	getDesktopSize ()
	Returns the screen size.
static char	virtualKeyToChar (int vkey)
	Get ascii character from a Virtual Key.
Protected Member Functions
void	createMessageMap ()
	make the Windows Message Procedure dispatching map right.
Classes
class	Seed
	Info for creation. More...

Detailed Description

template<class EventHandlerClass, class MessageMapPolicy, class TextBoxType = NormalTextBox< EventHandlerClass, MessageMapPolicy >>
class SmartWin::WidgetTextBox< EventHandlerClass, MessageMapPolicy, TextBoxType >

You can either inherit from this class or add an instance of this class into your WidgetWindow inherited class.
If you inherit from the class you should explicitly call create e.g. in the CTOR of you class.
If you instantiate it directly (through the class Widget) you should create it by calling WidgetFactory::createxxx where xxx equals the name of the class WITHOUT the Widget part.

Member Function Documentation

void addRemoveExStyle	(	DWORD	addStyle,
		bool	add
	)			`[inherited]`

Use this function to add or remove windows exStyles.

The first parameter is the type of style you wish to add/remove.
The second argument is a boolean indicating if you wish to add or remove the style (if true add style, else remove)

void addRemoveStyle	(	DWORD	addStyle,
		bool	add
	)			`[inherited]`

Use this function to add or remove windows styles.

The first parameter is the type of style you wish to add/remove.
The second argument is a boolean indicating if you wish to add or remove the style (if true add style, else remove)

void bringToBottom ( ) [inherited]

Brings the widget to the bottom.

Makes the widget become the bottom most widget meaning it will be obscured by all other widgets which are contained in the same container widget.
For instance if you have two widgets which partially hides eachother and you call bringToBottom on one of them it will make sure that the widget you call bringToBottom on will be the one which will be invisible and the other one will be all visible by the parts which are obscured by the this widget.

void bringToFront ( ) [inherited]

Brings the widget to the front.

Makes the widget become the front most widget meaning it will not be obscured by other widgets which are contained in the same container widget.
For instance if you have two widgets which partially hides eachother and you call bringToFront on one of them it will make sure that the widget you call bringToFront on will be the one which will be all visible and the other one will be partially hidden by the parts which are obscured by the this widget.

virtual void create ( const Seed & cs = getDefaultSeed() ) [virtual]

Actually creates the TextBox.

You should call WidgetFactory::createTextBox if you instantiate class directly.
Only if you DERIVE from class you should call this function directly.

Rectangle getBounds ( ) const [inherited]

Returns the position and size of the window.

Note that this is in screen coordinates meaning the position returned is relative to the upper left corner of the desktop screen, the function also returns in the size member of the Rectangle the size of the window and not the position of the lower right point. Values includes borders, frames and toolbar etc of the window.

bool getCapsLockOn ( ) [inherited]

Checks if Caps Lock is on.

Use this function if you need to determine if Caps Lock is ON

Point getClientAreaSize ( ) const [inherited]

Returns the size of the client area of the window.

This differs from getSize because it disregards the border and headers, this function only returns the client area of the Widget meaning the area which it is possible to draw on.

bool getControlPressed ( ) [inherited]

Checks if control is pressed.

Use this function if you need to determine if any of the CTRL keys are pressed.

Utilities::CriticalSection & getCriticalSection ( ) [inherited]

Returns a CriticalSection associated with the current Widget object.

If you need serialized thread safe access to the Widget call this function and either stuff the returned object into a Utilities::ThreadLock or call Utilities::CriticalSection::lock (then you manually have to ensure CriticalSection::unlock is called on it)

HMENU getCtrlId ( ) const [inherited]

Returns the control id of the Widget.

This one only makes sense for control items, e.g. WidgetButton, WidgetComboBox etc.
Every control in a Widget has got its own control ID, mark that for a WidgetWindow this will always be ZERO

Point getDesktopSize ( ) [static, inherited]

Returns the screen size.

This is the screen size, and useful for making applications that must adapt to different screen sizes.

bool getEnabled ( ) const [inherited]

Retrieves the enabled property of the Widget.

Use this function to check if the Widget is Enabled or not. If the Widget is enabled this function will return true.

bool getFocus ( ) const [inherited]

Retrieves the focus property of the Widget.

Use this function to check if the Widget has focus or not. If the Widget has focus this function will return true.

FontPtr getFont ( ) [inherited]

Returns the font used by the Widget.

Returns the Font object currently being used by the Widget

Widget* getParent ( ) const [inherited]

Returns the parent Widget of the Widget.

Most Widgets have got a parent, this function will retrieve a pointer to the Widgets parent, if the Widget doesn't have a parent it will return a null pointer.

Point getPosition ( ) const [inherited]

Returns the position of the window.

Note that this is in screen coordinates meaning the position returned is relative to the upper left corner of the desktop screen.

Reimplemented in WidgetProgressBar, and WidgetSlider.

SmartUtil::tstring getSelection ( ) const

Returns the current selected text from the text box.

The selected text of the text box is the return value from this.

bool getShiftPressed ( ) [inherited]

Checks if shift is pressed.

Use this function if you need to determine if any of the SHIFT keys are pressed.

Point getSize ( ) const [inherited]

Returns the size of the window.

Includes the border, frame and toolbar etc of the window.

SmartUtil::tstring getText ( ) const [inherited]

Gets the text of the AspectText realizing class.

The Return value is the text of the realizing class.

DWORD getTextLimit ( ) const

Returns the maximum number of characters that can be entered.

Note that the maxChars returned will vary by OS if left unset.

Point getTextSize ( const SmartUtil::tstring & text ) [inherited]

Fills a Point with the size of text to be drawn in the Widget's font.

getTextSize determines the height and width that text will take.
This is useful if you want to allocate enough space to fit known text.
It accounts for the set font too.

bool getVisible ( ) const [inherited]

Retrieves the visible property of the Widget.

Use this function to check if the Widget is visible or not.
If the Widget is visible this function will return true.

HWND handle ( ) const [inherited]

Returns the HWND to the Widget.

Returns the HWND to the inner window of the Widget.
If you need to do directly manipulation of the window use this function to retrieve the HWND of the Widget.

void invalidateWidget ( ) [inherited]

Add this widget to the update area.

Same as updateWidget except that this does not force an immediate redraw.

void maximize ( ) [inherited]

Maximize your window.

This will make the window fill the whole area that the window has available.
This function cannot be called for any Widget types other than those derived from WidgetWindowBase.

void minimize ( ) [inherited]

Minimize your window.

This will make the window become minimized.
This function cannot be called for any Widget types other than those derived from WidgetWindowBase.

void onChar ( typename MessageMapType::itsBoolFunctionTakingInt eventHandler ) [inherited]

Setting the event handler for the "char" event.

If supplied event handler is called when control has the focus and character event occurs
parameter passed is int which is the character of the nonsystem key being pressed. Return value must be of type bool, if event handler returns true event is defined as "handled" meaning the system will not try itself to handle the event.
Certain widgets, such as WidgetTextBox, will not report VK_RETURN unless you include ES_WANTRETURN in the style field of of the creational structure passed when you createTextBox( cs ).

void onRaw	(	typename MessageMapType::itsHresultFunctionTakingLparamWparam	eventHandler,
		const Message &	msg
	)			`[inherited]`

Setting the member event handler for a "raw" event.

Sets the event handler for the "raw" event handler. Use this if any of the predefined Event Handlers are not powerful enough or if you can't find the specific Event Handler you need.
Note!
This works in a special way. Unless you add the same Message twice, it will add that Event Handler and not remove the previous one. You can have "multiple" raw Event Handlers as long as the Message is not the same!
Note also!
This is an UNTYPED Event!
If there are other events which will handle the message, USE THOSE instead of this one!!!
This is a "last resort" event type.
Two parameters are passed: LPARAM and WPARAM
Return value is HRESULT which will be passed on to the System

void replaceSelection	(	const SmartUtil::tstring &	txt,
		bool	canUndo = `true`
	)

Replaces the currently selected text in the text box with the given text parameter.

If canUndo is true this operation is stacked into the undo que ( can be undone ), else this operation cannot be undone.
Note!
If there is not currently any selected text, the input text is inserted at the current location of the caret.

void restore ( ) [inherited]

Restores your window.

This will make the window become restored.
This function cannot be called for any Widget types other than those derived from WidgetWindowBase.

LRESULT sendWidgetMessage	(	HWND	hWnd,
		UINT	msg,
		WPARAM &	wPar,
		LPARAM &	lPar
	)			`[virtual]`

Send a message to the Widget.

If you need to be able to send a message to a Widget then use this function as it will unroll into
a SendMessage from the Windows API

Reimplemented from MessageMapControl< EventHandlerClass, TextBoxType::TextBoxType, MessageMapPolicy >.

Reimplemented in WidgetRichTextBox.

void setBorder ( bool value = true )

Adds (or removes) a border surrounding the control.

If you pass false you REMOVE the border of the control ( if there is on )
If you pass true to the function, you ADD a border.

Reimplemented from AspectBorder< TextBoxType::TextBoxType >.

void setBounds	(	int	x,
		int	y,
		int	width,
		int	height,
		bool	updateWindow = `true`
	)			`[inherited]`

Sets the new size and position of the window.

x is the new horizontal position of your window.
y is the new vertical position of your window.
width is the new width and height is the new height of your window.
Zenith is as in all other bounds function top/left.
A call to this function will (probably) also MOVE your Widget too.

void setBounds	(	const Point &	newPos,
		const Point &	newSize,
		bool	updateWindow = `true`
	)			`[inherited]`

Sets the new size and position of the window.

The input parameter newPos of type Point defines the new position of the window.
The newSize member of type Point is the new size of the window.
A call to this function will (probably) also MOVE your Widget too.

void setBounds	(	const Rectangle &	rect,
		bool	updateWindow = `true`
	)			`[inherited]`

Sets the new size and position of the window.

The input parameter Rectangle defines the new size (and position) of the window.
The pos member of the Rectangle is the position and the size member is the size.
So a call to this function will (probably) also MOVE your Widget too.

void setEnabled ( bool enabled ) [inherited]

Sets the enabled property of the Widget.

Changes the enabled property of the Widget. Use this function to change the enabled property of the Widget

void setFocus ( ) [inherited]

Gives the Widget the keyboard focus.

Use this function if you wish to give the Focus to a specific Widget

void setFont	(	PredefinedFontTypes	stockObjectFont,
		bool	forceUpdate = `true`
	)			`[inherited]`

Function taking a PredefinedFontTypes type.

Examples are SystemFixedFont, SystemFont or DefaultGuiFont. -- credit to mm.

void setFont	(	FontPtr	font,
		bool	forceUpdate = `true`
	)			`[inherited]`

Sets the font used by the Widget.

Changes the font of the Widget to the given font. Use the class Font to construct a font in which to set by this function.

void setLowerCase ( bool value = true )

Adds (or removes) lower case forcing.

If you pass false you remove this ability
If you pass true or call function without arguments you force the control to display all characters in lower case.

void setNumbersOnly ( bool value = true )

Adds (or removes) the numbers property.

If you pass false you remove this ability
If you pass true or call function without arguments you force the control to display only numbers.

void setPassword	(	bool	value = `true`,
		TCHAR	pwdChar = `'*'`
	)

Adds (or removes) the password property.

If you pass false you remove this ability
If you pass true or call function without arguments you force the control to display all its content as "hidden" meaning it will only display e.g. "*" instead of letters, useful for Text Box Controls which contains passwords or similar "secret" information.

void setPositionPerPlace ( SmartWin::Place & bound ) [inherited]

Given a bounding Place class, place this Widget and adjust to the next position.

This function places the Widget into the bounding rectangle specified by bound.
The size of the Widget is preserved.
The Widgets are sized and placed from left to right until a row is full, and then continues with the next row.
The internal position of bound is updated.

void setReadOnly ( bool value = true )

Adds (or removes) the readonly property.

If you pass false you remove this ability
If you pass true or call function without arguments you force the control to display as a readonly text field.

void setScrollBarHorizontally ( bool value = true )

Adds (or removes) the control horizontal scroll bars.

If you pass false you REMOVE the horizontal scrollbars of the control ( if there are any )
If you pass true to the function, you ADD horizontal scrollbars.
Value defaults to true!

void setScrollBarVertically ( bool value = true )

Adds (or removes) the control vertical scroll bars.

If you pass false you REMOVE the vertical scrollbars of the control ( if there are any )
If you pass true to the function, you ADD vertical scrollbars.

void setSelection	(	long	start = `0`,
		long	end = `-1`
	)

Sets the current selection of the Edit Control.

Start means the offset of where the current selection shall start, if it is omitted it defaults to 0.
end means where it shall end, if it is omitted it defaults to - 1 or "the rest from start".

void setSizeAsCol	(	const Rectangle &	rect,
		int	rows,
		int	rownum,
		int	border = `0`,
		bool	updateWindow = `true`
	)			`[inherited]`

Given a bounding rectangle with rows, put this Widget in the rownum position.

The rect defines a column made up of a number of rows. The rownum specifies a zero based index of the row to place the Widget. [ row0 ]
[ row1 ]
...
[ rownum ]
[ ]

Of course you could just generate a new bounding rectangle, but this is easier.

void setSizeAsGridPerPlace	(	SmartWin::Place &	bound,
		int	rows,
		int	cols
	)			`[inherited]`

this Widget in the next cell.

Bound determines the bounding rectangle, and borders.
rows and cols determine the size and position of each cell.
The internal position of bound is updated.
The Widgets are sized and placed according to the current cell, from left to right until a row is full, and then continues with the next row.

void setSizeAsRow	(	const Rectangle &	rect,
		int	cols,
		int	colnum,
		int	border = `0`,
		bool	updateWindow = `true`
	)			`[inherited]`

Given a bounding rectangle with cols, put this Widget in the colnum position.

The rect defines a row made up of a number of columns. The colnum specifies a zero based index of the column to place the Widget.
[ col0 ] [ col1 ] ... [ colnum ] [ ] [ ]

void setSizePerTextPerPlace	(	SmartWin::Place &	bound,
		const SmartUtil::tstring &	text,
		int	extraX = `0`,
		int	extraY = `0`
	)			`[inherited]`

Place after sizing for the Widget's text, and adjust to the next position.

This function places the Widget into the bounding rectangle specified by bound.
The idea is that the size of certain Widgets should really be large enough to show their text. Buttons and text areas are examples.
The size of the Widget is calculated from the size of getText().
It is optionally adjusted by the extraX and extraY.
The Widgets are sized and placed from left to right until a row is full, and then continues with the next row.
The internal position of bound is updated.

void setText ( const SmartUtil::tstring & txt ) [inherited]

Sets the text of the AspectText realizing class.

The txt parameter is the new text to put into the realizing object.

void setTextLimit ( DWORD maxChars )

Set the maximum number of characters that can be entered.

Although this prevents user from entering more maxChars, Paste can overrun the limit.

void setUpperCase ( bool value = true )

Adds (or removes) upper case forcing.

If you pass false you remove this ability
If you pass true or call function without arguments you force the control to display all characters in UPPER CASE.

void setVisible ( bool visible ) [inherited]

Sets the visibility property of the Widget.

Changes the visibility property of the Widget.
Use this function to change the visibility property of the Widget

void showCaret ( )

Call this function to scroll the caret into view.

If the caret is not visible within the currently scrolled in area, the Text Box will scroll either down or up until the caret is visible.

void subclass ( unsigned id ) [virtual, inherited]

Subclasses the dialog item with the given dialog item id.

Subclasses a dialog item, the id is the dialog item id from the resource editor.
Should normally not be called directly but rather called from e.g. one of the creational functions found in the WidgetFactory class.

void updateWidget ( ) [inherited]

Repaints the whole window.

Invalidate the window and repaints it.

char virtualKeyToChar ( int vkey ) [static, inherited]

Get ascii character from a Virtual Key.

Use this to convert from the input to the response to onKeyPressed to a character.
Virtual Keys do not take into account the shift status of the keyboard, and always report UPPERCASE letters.

WidgetTextBox Class Template Reference [Widgets]

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Classes

Detailed Description

template<class EventHandlerClass, class MessageMapPolicy, class TextBoxType = NormalTextBox< EventHandlerClass, MessageMapPolicy >> class SmartWin::WidgetTextBox< EventHandlerClass, MessageMapPolicy, TextBoxType >

Member Function Documentation

WidgetTextBox Class Template Reference
[Widgets]

template<class EventHandlerClass, class MessageMapPolicy, class TextBoxType = NormalTextBox< EventHandlerClass, MessageMapPolicy >>
class SmartWin::WidgetTextBox< EventHandlerClass, MessageMapPolicy, TextBoxType >