MHEG  17.9.0
 All Data Structures Files Functions Variables Typedefs Enumerations Macros Pages
Data Structures | Enumerations | Functions
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>=""> 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

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
void MHEG5entryfieldBACKSPACE ( MHEG5Entryfield *  entryfield)

Perform action of backspace key on interacting Entryfield.

Parameters
entryfieldEntryfield object to apply key press to
Returns
Void
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
void MHEG5entryfieldDestruct ( MHEG5Entryfield *  entryfield)

Destruct a entryfield object.

Parameters
MHEG5Entryfield*entryfield
Returns
void
void MHEG5entryfieldEXIT ( MHEG5Entryfield *  entryfield)

Perform action of exit key on interacting Entryfield.

Parameters
entryfieldEntryfield 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
entryfieldPointer to object to free.
Returns
Void
void MHEG5entryfieldInit ( MHEG5Entryfield *  entryfield)

<Function description>="">

Returns
<Return value>=""> Initialise an entryfield object with default values.
Parameters
entryfieldPointer to object to initialise.
Returns
Void

<Function description>="">

Parameters
entryfieldPointer to object to initialise.
Returns
Void
void MHEG5entryfieldInsert ( MHEG5Entryfield *  entryfield,
unsigned short  c 
)

Add the character |c| to the Entryfield.

Parameters
MHEG5Entryfield*entryfield
charc
Returns
void
void MHEG5entryfieldLEFT ( MHEG5Entryfield *  entryfield)

Perform action of left arrow key on interacting Entryfield.

Parameters
entryfieldEntryfield object to apply key press to
Returns
Void
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
void MHEG5entryfieldRIGHT ( MHEG5Entryfield *  entryfield)

Perform action of right arrow key on interacting Entryfield.

Parameters
entryfieldEntryfield object to apply key press to
Returns
Void
void MHEG5entryfieldSELECT ( MHEG5Entryfield *  entryfield)

Perform action of select key on interacting Entryfield.

Parameters
entryfieldEntryfield object to apply key press to
Returns
Void
void MHEG5entryfieldUserInput ( MHEG5Entryfield *  entryfield,
E_MHEG5_KEY  ui 
)

Test user input and perform required actions.

Parameters
entryfieldEntryfield object to apply key press to
uiKey Pressed
Returns
Void
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
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
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
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
Generated on Tue Sep 19 2017 16:29:49 for MHEG by   doxygen 1.8.6