gbmmi.h

某中文手写输入法公司的手写识别输入的实例源程序。

	GBET_In_Key,///< key event
				///< \param param1 : \ref GBKey
				///< \param param2 : \ref GBKeyType
	
	GBET_In_Deinit,///< deinit event
				   ///< \param param1 : not used
				   ///< \param param2 : not used
				   
	GBET_In_ReSet,///< reset current input mode.
				  ///< \param param1 : no used. 
				  ///< \param param2 : no used. 

	GBET_In_GetAssociate,///< get associate words in chinese mode.
						 /// \param param1 : input string.
						 /// \param param2 : no used.

	GBET_In_ReSearch,/// research code table in Chinese input mode.
					 /// \param param1 : inner code of a chinese word.
					 /// \param param2 : output buffer.

	GBET_In_SetLatinEngineOption,/// set the output's format of word.
								/// \param param1 : options of the output's format
								/// \param param2 : no used.

	GBET_In_SetPinYinIndex,/// set the index of syllables in GBPinYin's mode
						   /// \param param1 : the index of syllables
						   /// \param param2 : no used.

	GBET_In_SelCandidate,/// a candidate up screen when it is hitted in visual keyboard 
					     /// or be in the long press mode. 
						 /// \param param1 : the index of candidate.
						 // \param param2 : no used.

	//检查结构体GBInitData的大小是否跟引擎匹配
	//param1 (in) sizeof(GBInitData)
	//param2 (out) 引擎中GBInitData的大小
	//如果两者不一致则返回GBMR_Failed, 否则返回GBMR_OK
	GBET_In_Check_InitData_Size,

	//检查结构体GBMMIGlobals的大小是否跟引擎匹配
	//param1 (in) sizeof(GBMMIGlobals)
	//param2 (out) 引擎中GBMMIGlobals的大小
	//如果两者不一致则返回GBMR_Failed, 否则返回GBMR_OK
	GBET_In_Check_GBMMIGlobals_Size,
	
	//检查候选是否能向后翻页
	//param1 (out) 1--能向后翻页，0--不能
	//param2 nouse,
	GBET_In_Cand_CanPageDown,

	//检查候选是否能向前翻页
	//param1 (out) 1--能向前翻页，0--不能
	//param2 nouse,
	GBET_In_Cand_CanPageUp,
					 
	GBET_In_Max,


	GBET_Out_Null					= 0x80,
	//for ZTE Spreadstrum, get input key sequence out of GBMMI
	GBET_Get_Input_Str,
	
	//增加自造词
	GBET_Add_ShPhrase,
	//param1 (in) 指向增加自造词的字符串

	//删除制定自造词
	GBET_Delete_ShPhrase, 
	//param1 (in) 指向删除自造词的字符串

	//开始遍历自造词
	GBET_Start_SearchShPhrase,

	//遍历自造词
	GBET_Get_Next_ShPhrase,
	//param1 (out) 指向自造词字符串
	
	//翻到下一页拼音
	GBET_PinYin_NextPage,

	//翻到前一页拼音
	GBET_PinYin_PrevPage,

	GBET_Out_Max
} ;


/**********************************************************************************************
** 按键定义
**********************************************************************************************/
/** \enum GBKey
	\brief key defination
 */
enum GBKey
{
/* char key */
	GBKEY_NULL						= 0,

	GBKEY_0 						= '0',
	GBKEY_1							= '1',
	GBKEY_2							= '2',
	GBKEY_3							= '3',
	GBKEY_4							= '4',
	GBKEY_5							= '5',	
	GBKEY_6							= '6',	
	GBKEY_7							= '7',
	GBKEY_8							= '8',
	GBKEY_9							= '9',

	GBKEY_Star						= '*',			
	GBKEY_Sharp						= '#',

	GBKEY_Dot                       = '.',

	GBKEY_AT						= '@',
	

	GBKEY_Func_Null					= 0x80,
	GBKEY_0L,
	GBKEY_1L,
	GBKEY_2L,
	GBKEY_3L,
	GBKEY_4L,
	GBKEY_5L,
	GBKEY_6L,
	GBKEY_7L,
	GBKEY_8L,
	GBKEY_9L,
/* function key */
	GBKEY_Left,																	
	GBKEY_Right,
	GBKEY_Up,
	GBKEY_Down,
	GBKEY_OK,
	GBKEY_Back,
	GBKEY_Return,
	GBKEY_Page_Up,      // add by gjx 2007.07.21 to resolve yulong problem 触摸屏上的向左键
	GBKEY_Page_Down,    // add by gjx   触摸屏上的向右键
	GBKEY_TuchScreen_Up,   //add by gjx 2007.07.23  触摸屏上的向上键
	GBKEY_TuchScreen_Down,  //add by gjx 2007.07.23  触摸屏上的向下键
	GBKEY_WILD_CHAR,        //作为特殊的通配符键   kaven 2007.12.05

    // add by lzl 2008.03.13, 解决泰语的 * # 问题
    GBKEY_ThaiStar,
    GBKEY_ThaiSharp,
    // add by lzl 2008.03.13 end

    GBKEY_Num
} ;



/** \enum GBKeyType
	\brief key type defination
 */
enum GBKeyType
{
	GBKT_Down,
	GBKT_Up,
	GBKT_LongPress
} ;



/**********************************************************************************************
** 输出/显示结构
**********************************************************************************************/
/**
	\brief 输出/显示的辅助信息
*/
typedef struct __tag_GBOtherInfo
{	
	GBBOOL8							isAssociateMode ;///<是否处于中文联想模式
	GBBOOL8							isChnInterpunctionMode ;///<是否处于中文标点模式		
	GBBOOL8							isEnInterpunctionMode ;///<是否处于英文标点模式
	GBBOOL8							isSwitch ;///<是否处于中英文无缝切换状态
	GBBOOL8							isShowDownArrow ;///<中文:判断候选页是否能下翻 多语种:判断是否有NextHeader
	GBBOOL8							isShowUpArrow ;///<中文:判断候选页是否能上翻 多语种:判断是否有PreHeader
	GBBOOL8							isShowLeftArrow ;///判断是否能左移选择候选
	GBBOOL8							isShowRightArrow ;///判断是否能右移选择候选
	GBBOOL8							isSylLeftArrow ;///BBK只显示一个音节时，判断是否能左移音节，默认关闭
	GBBOOL8							isSylRightArrow ;///BBK只显示一个音节时，判断是否能右移音节，默认关闭
	GBBOOL8							enSelmakStatus;//看英文自造词状态，现在默认是关闭使用，如果要使用请在编译时加入	
													//__GB_EN_SELMAKE_STATUS__＝1
	GBBOOL8                         isShowSyllableArrow;//因为音节可以循环显示，所以音节超过1时此值为真。

	//chnPageCout and chnPageIndex 是取得中文候选页数信息而加上的，默认是关闭状态，如果要使用
	//请在编译库时加上 __GB_CHN_CAND_PAGE_INFO__＝1
    GBUINT16                        chnPageCount;
	GBUINT16                        chnPageIndex;

//	GBBYTE							reserved;
} GBOtherInfo;


/** \struct __tag_GBOutputInfo
	\brief output information for display
 */

typedef struct __tag_GBOutputInfo
{
	GBLanguage						nLanguage ;///< current language type, see \ref GBLanguage
	GBMMIInputMode					nInputMode ;///< current input mode, see \ref GBMMIInputMode

	GBUINT16	*					fullOutput;/**< 数字区内码串 */

#ifdef __GB_CHINESE_ENGINE__
	GBUINT16 						syllableNum;/**< 拼音音节的个数 */	
	GBUINT16						syllables[__GB_MAX_SYLLABLES][__GB_MESSAGE_MAX_LEN];/**< 拼音音节 */
	GBUINT16 						syllableIndex;/**< 拼音音节的索引，为0时表示当前选中数字区 */	
	
	GBUINT16 						stroke[__GB_MAX_INPUTLEN];/**< 笔画区内码串 */
	GBUINT16						strokeLen;///<当前显示的笔画个数
	
	GBUINT16 						components[__GB_MAX_COMPLEN];/**< 部首区内码串 */
	GBUINT16 						componentsLen;/**< 当前显示的部首个数	 */	
	GBUINT16						reserved;
#endif

	GBUINT16  	*					candidates[__GB_MAX_CANDIDATES];/**< 候选字词 */
	GBUINT16 						candidatesNum;/**< 候选项的个数 */
	GBUINT16 						candidateIndex;/**< 当前选择的候选项索引 */	
	GBUINT16						isSelectedCand;/**< 当前是否进入候选选择状态 */	

	GBUINT16						isShowIMWin;/**< 是否显示输入法窗口 */

	GBUINT16						isCanUpScreen;/**< 在当前状态下是否可以上屏*/
	GBUINT16	  					upscreenLen;/**< isCanUpScreen为真时,存放需要上屏的字符个数 */	
	GBUINT16	*					upscreenStr;/**< isCanUpScreen为真时,存放需要上屏的字符串 */
	
//#ifdef __GB_OPTIMIZE_FULLOUTPUT__
//	GBUINT16                        isFullOutputOptimize;/**< 当前状态是否要优化fulloutputstring*/
//	GBUINT16    *                   optimizeStr[32];/**< 优化后的fulloutputString*/
//#endif


	GBOtherInfo						otherInfo;///<辅助信息
} GBOutputInfo ;


/** \enum GBMMIReturn
	\brief MMI internal return values definition

	return values of chinese (see EB_defines.h) and latin engine (see GBLt_def.h) now plus an corresponding value to avoid conflict
	and define some values return by MMI
 */
enum GBMMIReturn
{
	GBMR_OK							= 0x00,	///< OK, event handled
	GBMR_Ignored					= 0x01,	///< event ignored

	GBMR_Failed						= 0x10,	///< return errors of MMI internal begin with this value
	GBMR_EngineNotInit,								///< engine not initialized
	GBMR_NoEngine,									///< no engine
	GBMR_NullEvent,									///< pointer to event is null!
	GBMR_InvalidEventType,							///< invalid event type! see \ref GBEventType
	GBMR_NullInitData,								///< pointer to init data is null when event type is GBEventType::GBET_In_Init
	GBMR_InvalidInputMode,							///< invalid input mode, see \ref GBInputMode
	GBMR_UnsupportedLanguageType,					///< unsupported language type
	GBMR_InvalidKeyType,							///< invalid key type, see \ref GBKeyType
	GBMR_InvalidKey,								///< invalid key, see \ref GBKey


	GBMR_Chn_Begin					= 0x21,	///< return errors of chinese engine plus with this value
	GBMR_Latin_Begin				= 0x22,	///< return errors of latin engine plus with this value

	GBMR_Latin_Init_Only            = 0x23, ///< Not an errore,just initialize Latin Engine.
	GBMR_Chn_Init_Only              = 0x24,  ///< Not an errore,just initialize Chn Engine,

	GBMR_Init_ArraySize_OutOfRange=0x25,

	GBMR_MMIConfigError             //!<GBMMI用户所使用的配置跟GBMMI Library本身的配置不一致。
} ;



/** \fn enum GBMMIReturn GBHandleInputEvent(GBEvent * pEvent)
	\brief the only one API interface

	\param pEvent : pointer to event structure
	\return see \ref GBMMIReturn for MMI internal return values' reference, see EB_defines.h for chinese return values, see GBLt_def.h for latin return values.
 */
GBAPI enum GBMMIReturn GBHandleInputEvent(GBEvent * pEvent) ;


#ifdef	__cplusplus
} ;
#endif	/* __cplusplus */

#endif	/* __GB_MMI_H__ */