Implement the MHEG5 EntryField Class. Defines an interaction widget used by the final user to edit and/or modify a text. Base classes: Text, Interactible. Subclasses: None. Status: Concrete class. More...

#include "mh5text.h"
#include "mh5interactible.h"
#include "mheg5_keypress.h"

Classes
struct	MHEG5Entryfield

Enumerations
enum	entryfieldCursor_t { CURSOR_INSERT, CURSOR_REPLACE }

Functions
void	MHEG5entryfieldInit (MHEG5Entryfield *entryfield)
	<Function description>=""> More...

void	MHEG5entryfieldFree (MHEG5Entryfield *entryfield)
	Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed. More...

void	MHEG5entryfieldPrepare (MHEG5Entryfield *entryfield)
	Apply the preparation behaviour of the entryfield class Apply the preparation behaviour of the entryfield class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class. More...

void	MHEG5entryfieldActivate (MHEG5Entryfield *entryfield)
	Apply the activation behaviour of the entryfield class. As this class has no own activation behaviour this function just invokes the activation behaviour from the base class. More...

void	MHEG5entryfieldDeactivate (MHEG5Entryfield *entryfield)
	Apply the deactivation behaviour of the entryfield class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class. More...

void	MHEG5entryfieldDestruct (MHEG5Entryfield *entryfield)
	Destruct a entryfield object. More...

void	MHEG5entryfieldInsert (MHEG5Entryfield *entryfield, unsigned short c)
	Add the character \|c\| to the Entryfield. More...

MHEG5ErrorCode	MHEG5setOverwriteMode (MHEG5Root target, MHEG5GList params)
	Set the overwrite mode of the entryfield to the new value of the parameter Implementation of the SetOverwriteMode action of the entryfield class. More...

MHEG5ErrorCode	MHEG5getOverwriteMode (MHEG5Root target, MHEG5GList params)
	Retrieve the overwrite mode of the entryfield Implementation of the GetOverwriteMode action of the entryfield class. More...

MHEG5ErrorCode	MHEG5setEntryPoint (MHEG5Root target, MHEG5GList params)
	Set the entrypoint for the entryfield Implementation of the SetEntryPoint action of the entryfield class. More...

MHEG5ErrorCode	MHEG5getEntryPoint (MHEG5Root target, MHEG5GList params)
	Retrieve the current entrypoint of the entryfield Implementation of the GetEntryPoint action of the entryfield class. More...

void	MHEG5entryfieldBACKSPACE (MHEG5Entryfield *entryfield)
	Perform action of backspace key on interacting Entryfield. More...

void	MHEG5entryfieldLEFT (MHEG5Entryfield *entryfield)
	Perform action of left arrow key on interacting Entryfield. More...

void	MHEG5entryfieldRIGHT (MHEG5Entryfield *entryfield)
	Perform action of right arrow key on interacting Entryfield. More...

void	MHEG5entryfieldSELECT (MHEG5Entryfield *entryfield)
	Perform action of select key on interacting Entryfield. More...

void	MHEG5entryfieldEXIT (MHEG5Entryfield *entryfield)
	Perform action of exit key on interacting Entryfield. More...

void	MHEG5entryfieldUserInput (MHEG5Entryfield *entryfield, E_MHEG5_KEY ui)
	Test user input and perform required actions. More...

Detailed Description

Implement the MHEG5 EntryField Class. Defines an interaction widget used by the final user to edit and/or modify a text. Base classes: Text, Interactible. Subclasses: None. Status: Concrete class.

Date: 01/02/2002

Author: R.Freeman

Definition in file mh5entryfield.h.

Enumeration Type Documentation

enum entryfieldCursor_t

Enumerator
CURSOR_INSERT
CURSOR_REPLACE

Definition at line 61 of file mh5entryfield.h.

Function Documentation

void MHEG5entryfieldActivate ( MHEG5Entryfield * entryfield )

Apply the activation behaviour of the entryfield class. As this class has no own activation behaviour this function just invokes the activation behaviour from the base class.

Parameters

MHEG5Entryfield *entryfield

Returns: void

Definition at line 369 of file mh5entryfield.c.

void MHEG5entryfieldBACKSPACE ( MHEG5Entryfield * entryfield )

Perform action of backspace key on interacting Entryfield.

Parameters

entryfield Entryfield object to apply key press to

Returns: Void

Definition at line 591 of file mh5entryfield.c.

void MHEG5entryfieldDeactivate ( MHEG5Entryfield * entryfield )

Apply the deactivation behaviour of the entryfield class. As this class has no own deactivation behaviour this function just invokes the deactivation behaviour from the base class.

Parameters

MHEG5Entryfield *entryfield

Returns: void

Definition at line 389 of file mh5entryfield.c.

void MHEG5entryfieldDestruct ( MHEG5Entryfield * entryfield )

Destruct a entryfield object.

Parameters

MHEG5Entryfield *entryfield

Returns: void

Definition at line 405 of file mh5entryfield.c.

void MHEG5entryfieldEXIT ( MHEG5Entryfield * entryfield )

Perform action of exit key on interacting Entryfield.

Parameters

entryfield Entryfield object to apply key press to

Returns: Void

Definition at line 669 of file mh5entryfield.c.

void MHEG5entryfieldFree ( MHEG5Entryfield * entryfield )

Free off all memory associated with the specified object, including any exchanged attributes and internal data. The data holding the object itself is not freed.

Parameters

entryfield Pointer to object to free.

Returns: Void

Definition at line 281 of file mh5entryfield.c.

void MHEG5entryfieldInit ( MHEG5Entryfield * entryfield )

Returns: <Return value>=""> Initialise an entryfield object with default values.

Parameters

entryfield Pointer to object to initialise.

Returns: Void

Parameters

entryfield Pointer to object to initialise.

Returns: Void

Definition at line 266 of file mh5entryfield.c.

void MHEG5entryfieldInsert	(	MHEG5Entryfield *	entryfield,
		unsigned short	c
	)

Add the character |c| to the Entryfield.

Parameters

MHEG5Entryfield	*entryfield
char	c

Returns: void

Definition at line 211 of file mh5entryfield.c.

void MHEG5entryfieldLEFT ( MHEG5Entryfield * entryfield )

Perform action of left arrow key on interacting Entryfield.

Parameters

entryfield Entryfield object to apply key press to

Returns: Void

Definition at line 626 of file mh5entryfield.c.

void MHEG5entryfieldPrepare ( MHEG5Entryfield * entryfield )

Apply the preparation behaviour of the entryfield class Apply the preparation behaviour of the entryfield class. As this class has no own preparation behaviour this function just invokes the preparation behaviour from the base class.

Parameters

MHEG5Entryfield *entryfield

Returns: void

Definition at line 321 of file mh5entryfield.c.

void MHEG5entryfieldRIGHT ( MHEG5Entryfield * entryfield )

Perform action of right arrow key on interacting Entryfield.

Parameters

entryfield Entryfield object to apply key press to

Returns: Void

Definition at line 639 of file mh5entryfield.c.

void MHEG5entryfieldSELECT ( MHEG5Entryfield * entryfield )

Perform action of select key on interacting Entryfield.

Parameters

entryfield Entryfield object to apply key press to

Returns: Void

Definition at line 652 of file mh5entryfield.c.

void MHEG5entryfieldUserInput	(	MHEG5Entryfield *	entryfield,
		E_MHEG5_KEY	ui
	)

Test user input and perform required actions.

Parameters

entryfield	Entryfield object to apply key press to
ui	Key Pressed

Returns: Void

Definition at line 806 of file mh5entryfield.c.

MHEG5ErrorCode MHEG5getEntryPoint	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Retrieve the current entrypoint of the entryfield Implementation of the GetEntryPoint action of the entryfield class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

Definition at line 550 of file mh5entryfield.c.

MHEG5ErrorCode MHEG5getOverwriteMode	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Retrieve the overwrite mode of the entryfield Implementation of the GetOverwriteMode action of the entryfield class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

Definition at line 459 of file mh5entryfield.c.

MHEG5ErrorCode MHEG5setEntryPoint	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Set the entrypoint for the entryfield Implementation of the SetEntryPoint action of the entryfield class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

Definition at line 504 of file mh5entryfield.c.

MHEG5ErrorCode MHEG5setOverwriteMode	(	MHEG5Root *	target,
		MHEG5GList *	params
	)

Set the overwrite mode of the entryfield to the new value of the parameter Implementation of the SetOverwriteMode action of the entryfield class.

Parameters

MHEG5Root	*target
MHEG5GList	*params

Returns: MHEG5ErrorCode MHEG5ErrorCode

Definition at line 425 of file mh5entryfield.c.

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation