source/classes/inc/mh5entryfield.h File Reference

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"

Go to the source code of this file.

Data Structures
struct	MHEG5Entryfield
Enumerations
enum	entryfieldCursor_t { CURSOR_INSERT, CURSOR_REPLACE }
Functions
void	MHEG5entryfieldInit (MHEG5Entryfield *entryfield)
	<Function description>="">
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.
void	MHEG5entryfieldPrepare (MHEG5Entryfield *entryfield)
void	MHEG5entryfieldActivate (MHEG5Entryfield *entryfield)
void	MHEG5entryfieldDeactivate (MHEG5Entryfield *entryfield)
void	MHEG5entryfieldDestruct (MHEG5Entryfield *entryfield)
void	MHEG5entryfieldInsert (MHEG5Entryfield *entryfield, unsigned short c)
MHEG5ErrorCode	MHEG5setOverwriteMode (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5getOverwriteMode (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5setEntryPoint (MHEG5Root *target, MHEG5GList *params)
MHEG5ErrorCode	MHEG5getEntryPoint (MHEG5Root *target, MHEG5GList *params)
void	MHEG5entryfieldBACKSPACE (MHEG5Entryfield *entryfield)
	Perform action of backspace key on interacting Entryfield.
void	MHEG5entryfieldLEFT (MHEG5Entryfield *entryfield)
	Perform action of left arrow key on interacting Entryfield.
void	MHEG5entryfieldRIGHT (MHEG5Entryfield *entryfield)
	Perform action of right arrow key on interacting Entryfield.
void	MHEG5entryfieldSELECT (MHEG5Entryfield *entryfield)
	Perform action of select key on interacting Entryfield.
void	MHEG5entryfieldEXIT (MHEG5Entryfield *entryfield)
	Perform action of exit key on interacting Entryfield.
void	MHEG5entryfieldUserInput (MHEG5Entryfield *entryfield, E_MHEG5_KEY ui)

---

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

---

Function Documentation

void MHEG5entryfieldBACKSPACE

(

MHEG5Entryfield *

entryfield

)

Perform action of backspace key on interacting Entryfield.

Parameters:

entryfield

Entryfield object to apply key press to

Returns:

Void

void MHEG5entryfieldEXIT

(

MHEG5Entryfield *

entryfield

)

Perform action of exit key on interacting Entryfield.

Parameters:

entryfield

Entryfield object to apply key press to

Returns:

Void

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

void MHEG5entryfieldInit

(

MHEG5Entryfield *

entryfield

)

<Function description>="">

Returns:

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

Parameters:

entryfield

Pointer to object to initialise.

Returns:

Void

void MHEG5entryfieldLEFT

(

MHEG5Entryfield *

entryfield

)

Perform action of left arrow key on interacting Entryfield.

Parameters:

entryfield

Entryfield object to apply key press to

Returns:

Void

void MHEG5entryfieldRIGHT

(

MHEG5Entryfield *

entryfield

)

Perform action of right arrow key on interacting Entryfield.

Parameters:

entryfield

Entryfield object to apply key press to

Returns:

Void

void MHEG5entryfieldSELECT

(

MHEG5Entryfield *

entryfield

)

Perform action of select key on interacting Entryfield.

Parameters:

entryfield

Entryfield object to apply key press to

Returns:

Void