source/classes/inc/mh5entryfield.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 * Copyright © 2000 Koninklijke Philips Electronics N.V
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _MH5ENTRYFIELD_H_
#define _MH5ENTRYFIELD_H_

/*---includes for this file--------------------------------------------------*/
#include "mh5text.h"
#include "mh5interactible.h"
#include "mheg5_keypress.h"

/*---Constant and macro definitions for public use---------------------------*/

/*---Enumerations for public use---------------------------------------------*/

/*---Global type defs for public use-----------------------------------------*/
typedef struct
{
   /* Base classes */
   MHEG5Text text;
   MHEG5Interactible interactible;

   /* Exchanged attributes */
   enum {mh5alpha, mh5numeric, mh5any, mh5listed} inputType;
   MHEG5String charList;
   MHEG5Bool obscuredInput;
   MHEG5Int maxlength;

   /* Internal attributes */
   MHEG5Int entryPoint;
   MHEG5Bool overwriteMode;
} MHEG5Entryfield;

typedef enum { CURSOR_INSERT, CURSOR_REPLACE } entryfieldCursor_t;

/*---Global variable declarations for public use-----------------------------*/

/*---Global Function prototypes for public use-------------------------------*/

void MHEG5entryfieldInit(MHEG5Entryfield *entryfield);


void MHEG5entryfieldFree(MHEG5Entryfield *entryfield);


/*
    Internal behaviours
 */
void MHEG5entryfieldPrepare(MHEG5Entryfield *entryfield);
void MHEG5entryfieldActivate(MHEG5Entryfield *entryfield);
void MHEG5entryfieldDeactivate(MHEG5Entryfield *entryfield);
void MHEG5entryfieldDestruct(MHEG5Entryfield *entryfield);


void MHEG5entryfieldInsert(MHEG5Entryfield *entryfield, unsigned short c);

/*
   Actions
 */
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);


void MHEG5entryfieldLEFT(MHEG5Entryfield *entryfield);


void MHEG5entryfieldRIGHT(MHEG5Entryfield *entryfield);


void MHEG5entryfieldSELECT(MHEG5Entryfield *entryfield);


void MHEG5entryfieldEXIT(MHEG5Entryfield *entryfield);

void MHEG5entryfieldUserInput(MHEG5Entryfield *entryfield, E_MHEG5_KEY ui);

/*
   Debug
 */
#ifdef MH5PRINTOUT
void MHEG5entryfieldPrint(MHEG5Entryfield *entryfield, char *out);
#endif

#endif /*_MH5ENTRYFIELD_H_*/