#include <CzUITextBox.h>

Inheritance diagram for CzUITextBox:

Public Member Functions
void	setPrompt (const char *prompt)
CzString &	getPrompt ()
void	setTargetVariable (const char *name)
CzString &	getTargetVariable ()
void	setTypeHint (CzInput::eInputTypeHint hint)
CzInput::eInputTypeHint	getTypeHint () const
bool	setProperty (unsigned int property_name, const CzXomlProperty &data, bool delta)
	Sets the named property of the UITextBox.
bool	setProperty (unsigned int property_name, const CzString &data, bool delta)
	Sets the named property of the actor.
bool	getProperty (unsigned int property_name, CzXomlProperty &prop)
	Gets the named property of the actor.
	CzUITextBox ()
virtual void	NotifyTapped (int index, int x, int y, bool allow_bubble)
	OnTapped event handler.
virtual void	NotifyTextChanged ()
int	LoadFromXoml (IzXomlResource parent, bool load_children, CzXmlNode node)
	Creates an instance of this class from XML.
bool	UpdateFromAnimation (CzAnimInstance *animation)
	Updates actor property from supplied animation.
Static Public Member Functions
static void	InitClass ()
	Initialises the class.
static void	ReleaseClass ()
static bool	_setPrompt (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static CzXomlProperty	_getPrompt (IzXomlResource *target)
static bool	_setVariable (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static CzXomlProperty	_getVariable (IzXomlResource *target)
static bool	_setTypeHint (IzXomlResource *target, const CzXomlProperty &prop, bool add)
static CzXomlProperty	_getTypeHint (IzXomlResource *target)
static bool	_setOnTextChanged (IzXomlResource *target, const CzXomlProperty &prop, bool add)
Protected Member Functions
bool	UpdateBinding (unsigned int property_name, CzXomlVariable *var)
	Updates an actor property from the supplied XOML variable.
Protected Attributes
CzString	Prompt
CzString	TargetVariable
CzInput::eInputTypeHint	TypeHint
Static Protected Attributes
static CzXomlClassDef *	UITextBoxClassDef = NULL

Constructor & Destructor Documentation

CzUITextBox::CzUITextBox ( )

Member Function Documentation

CzXomlProperty CzUITextBox::_getPrompt ( IzXomlResource * target ) [static]

CzXomlProperty CzUITextBox::_getTypeHint ( IzXomlResource * target ) [static]

CzXomlProperty CzUITextBox::_getVariable ( IzXomlResource * target ) [static]

bool CzUITextBox::_setOnTextChanged	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		`[static]`

bool CzUITextBox::_setPrompt	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		`[static]`

bool CzUITextBox::_setTypeHint	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		`[static]`

bool CzUITextBox::_setVariable	(	IzXomlResource *	target,
		const CzXomlProperty &	prop,
		bool	add
	)		`[static]`

CzString& CzUITextBox::getPrompt ( ) [inline]

bool CzUITextBox::getProperty	(	unsigned int	property_name,
		CzXomlProperty &	prop
	)		`[virtual]`

Gets the named property of the actor.

Returns the named property of the actor. The properties value is returned in a CzXomlProperty which is a structure that contains a union of all possible property types. Note that as CzUITextBox is derived from CzUILabel, all CzUILabel properties will also be checked against.

Parameters:

	property_name	Name of the property.
[out]	prop	The property data that.

Returns:: true if it succeeds, false if property does not exist.

Reimplemented from CzUILabel.

CzString& CzUITextBox::getTargetVariable ( ) [inline]

CzInput::eInputTypeHint CzUITextBox::getTypeHint ( ) const [inline]

void CzUITextBox::InitClass ( ) [static]

Initialises the class.

Sets up the classes avaiiable properties. Used by the XOML system to find, set amd get class properties.

Reimplemented from CzUILabel.

int CzUITextBox::LoadFromXoml	(	IzXomlResource *	parent,
		bool	load_children,
		CzXmlNode *	node
	)		`[virtual]`

Creates an instance of this class from XML.

LoadFromXoml is the main method used by all classes that can be instantiated from XOML mark-up. This method creates an instance of this class from the supplied XML node structure specified by node. if parent is not NULL then the created instance will utilise the supplied parent to determine where it should live within the app. For example, if the parent is a scene then the actor will be placed in that scene. if the parent is another actor then this actor will be placed into the scene of the supplied actor and linked as a child to the parent actor. If load_chlldren is true then any child nodes contained within the actor will also be loaded. Note that as CzUIBase is derived from CzActorImage, CzActorImage::LoadFromXoml() will also be called to load CzActor specific properties.

Parameters:

[in]	parent	If non-null, the parent.
	load_children	true to load child nodes.
[in]	node	If non-null, the XOML markup node that defines this object

Returns:: negative value for error. if 0 then processing of further XOML will stop.

Reimplemented from CzUILabel.

void CzUITextBox::NotifyTapped	(	int	index,
		int	x,
		int	y,
		bool	allow_bubble
	)		`[virtual]`

OnTapped event handler.

The OnTapped event handler is called whenever the actor is tapped on by the user. Actors can process up to 5 simultaneous touch events OnTapped to OnTapped5. if event bubbling is enabled then the event will also be passed up to the parent.

This version of this method enables actors to utilise a selected and toggled state

Parameters:

index	Index of the touch.
x	The touched x coordinate.
y	The touched y coordinate.
allow_bubble	true to allow event bubbling, false to deny event bubbling.

Reimplemented from CzUIBase.

void CzUITextBox::NotifyTextChanged ( ) [virtual]

void CzUITextBox::ReleaseClass ( ) [static]

Reimplemented from CzUILabel.

void CzUITextBox::setPrompt ( const char * prompt ) [inline]

bool CzUITextBox::setProperty	(	unsigned int	property_name,
		const CzXomlProperty &	data,
		bool	delta
	)		`[virtual]`

Sets the named property of the UITextBox.

Sets the named property of this UITextBox. The properties value supplied will be converted. If delta is set to true then the existing value of the property will be added to instead of replaced.

Parameters:

	property_name	Name of the property as a string hash (faster searching).
[in]	data	The property data.
	delta	true if property should be added to instead of replaced.

Returns:: true if it succeeds, false if property does not exist.

Reimplemented from CzUILabel.

bool CzUITextBox::setProperty	(	unsigned int	property_name,
		const CzString &	data,
		bool	delta
	)		`[virtual]`

Sets the named property of the actor.

Sets the named property of this actor. The properties value (data) is supplied as a string and will be converted. If delta is set to true then the existing value of the property will be added to instead of replaced. Note that as CzUITextBox is derived from CzUILabel, all CzUILabel properties will also be checked against.

Parameters:

	property_name	Name of the property as a string hash (faster searching).
[in]	data	The property data.
	delta	true to property should be added to instead of replaced.

Returns:: true if it succeeds, false if property does not exist.

Reimplemented from CzUILabel.

void CzUITextBox::setTargetVariable ( const char * name ) [inline]

void CzUITextBox::setTypeHint ( CzInput::eInputTypeHint hint ) [inline]

bool CzUITextBox::UpdateBinding	(	unsigned int	property_name,
		CzXomlVariable *	var
	)		`[protected, virtual]`

Updates an actor property from the supplied XOML variable.

Updates a single property from the value of the bound XOML variable. Note that as CzUITextBox is derived from CzUILabel, all CzUILabel properties will also be checked against.

Parameters:

	property_name	Name of the property.
[in,out]	var	If non-null, the variable.

Returns:: true if it succeeds, false if property does not exist.

Reimplemented from CzUILabel.

bool CzUITextBox::UpdateFromAnimation ( CzAnimInstance * animation ) [virtual]

Updates actor property from supplied animation.

Updates the actors property that is specified by the supplied animation. When a timeline animation targets the property of an actor this method will be called by the animation to move the animations frame data into its target property. Note that as CzUITextBox is derived from CzUILabel, all CzUILabel properties will also be checked against.

Parameters:

[in] animation If non-null, the animation.

Returns:: true if it succeeds, false if property does not exist.

Reimplemented from CzUILabel.

Member Data Documentation

CzString CzUITextBox::Prompt [protected]

CzString CzUITextBox::TargetVariable [protected]

CzInput::eInputTypeHint CzUITextBox::TypeHint [protected]

CzXomlClassDef * CzUITextBox::UITextBoxClassDef = NULL [static, protected]

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

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation