aeetext.h

BREW SDK 3.1。BREW应用程序的开发包。

AEE_TM_CROATIAN_R: Key presses will enter Croatian characters as like rapid text entry
AEE_TM_CZECH: Key presses will enter Czech characters as like multitap
AEE_TM_CZECH_R: Key presses will enter Czech characters as like rapid text entry
AEE_TM_HUNGARIAN: Key presses will enter Hungarian characters as like multitap
AEE_TM_HUNGARIAN_R: Key presses will enter Hungarian characters as like rapid text entry
AEE_TM_ROMANIAN: Key presses will enter Romanian characters as like multitap
AEE_TM_ROMANIAN_R: Key presses will enter Romanian characters as like rapid text entry
AEE_TM_RUSSIAN: Key presses will enter Russian characters as like multitap
AEE_TM_RUSSIAN_R: Key presses will enter Russian characters as like rapid text entry
AEE_TM_SERBIAN: Key presses will enter Serbian characters as like multitap
AEE_TM_SERBIAN_R: Key presses will enter Serbian characters as like rapid text entry
AEE_TM_SLOVAK: Key presses will enter Slovak characters as like multitap
AEE_TM_SLOVAK_R: Key presses will enter Slovak characters as like rapid text entry
AEE_TM_SLOVENIAN: Key presses will enter Slovenian characters as like multitap
AEE_TM_SLOVENIAN_R: Key presses will enter Slovenian characters as like rapid text entry
AEE_TM_TURKISH: Key presses will enter Turkish characters as like multitap
AEE_TM_TURKISH_R: Key presses will enter Turkish characters as like rapid text entry
AEE_TM_UKRAINIAN: Key presses will enter Ukrainian characters as like multitap
AEE_TM_UKRAINIAN_R: Key presses will enter Ukrainian characters as like rapid text entry
AEE_TM_DANISH: Key presses will enter Danish characters as like multitap
AEE_TM_DANISH_R: Key presses will enter Danish characters as like rapid text entry
AEE_TM_DUTCH: Key presses will enter Dutch characters as like multitap
AEE_TM_DUTCH_R: Key presses will enter Dutch characters as like rapid text entry
AEE_TM_FINNISH: Key presses will enter Finnish characters as like multitap
AEE_TM_FINNISH_R: Key presses will enter Finnish characters as like rapid text entry
AEE_TM_FRENCH_EU: Key presses will enter European French characters as like multitap
AEE_TM_FRENCH_EU_R: Key presses will enter European French characters as like rapid text entry
AEE_TM_GERMAN: Key presses will enter German characters as like multitap
AEE_TM_GERMAN_R: Key presses will enter German characters as like rapid text entry
AEE_TM_GREEK: Key presses will enter Greek characters as like multitap
AEE_TM_GREEK_R: Key presses will enter Greek characters as like rapid text entry
AEE_TM_ITALIAN: Key presses will enter Italian characters as like multitap
AEE_TM_ITALIAN_R: Key presses will enter Italian characters as like rapid text entry
AEE_TM_NORWEGIAN: Key presses will enter Norwegian characters as like multitap
AEE_TM_NORWEGIAN_R: Key presses will enter Norwegian characters as like rapid text entry
AEE_TM_POLISH: Key presses will enter Polish characters as like multitap
AEE_TM_POLISH_R: Key presses will enter Polish characters as like rapid text entry
AEE_TM_PORTUGUESE_EU: Key presses will enter European Portuguese characters as like multitap
AEE_TM_PORTUGUESE_EU_R: Key presses will enter European Portuguese characters as like rapid text entry
AEE_TM_SPANISH_EU: Key presses will enter European Spanish characters as like multitap
AEE_TM_SPANISH_EU_R: Key presses will enter European Spanish characters as like rapid text entry
AEE_TM_SWEDISH: Key presses will enter Swedish characters as like multitap
AEE_TM_SWEDISH_R: Key presses will enter Swedish characters as like rapid text entry
AEE_TM_INDONESIAN: Key presses will enter Indonesian characters as like multitap
AEE_TM_INDONESIAN_R: Key presses will enter Indonesian characters as like rapid text entry
AEE_TM_MALAY: Key presses will enter Malay characters as like multitap
AEE_TM_MALAY_R: Key presses will enter Malay characters as like rapid text entry
AEE_TM_TAGALOG: Key presses will enter Tagalog characters as like multitap
AEE_TM_TAGALOG_R: Key presses will enter Tagalog characters as like rapid text entry
AEE_TM_THAI: Key presses will enter Thai characters as like multitap
AEE_TM_THAI_R: Key presses will enter Thai characters as like rapid text entry
AEE_TM_VIETNAMESE: Key presses will enter Vietnamese characters as like multitap
AEE_TM_VIETNAMESE_R: Key presses will enter Vietnamese characters as like rapid text entry
AEE_TM_FRENCH_CA: Key presses will enter Canadian French characters as like multitap
AEE_TM_FRENCH_CA_R: Key presses will enter Canadian French characters as like rapid text entry
AEE_TM_PORTUGUESE_BR: Key presses will enter Brasilian Portuguese characters as like multitap
AEE_TM_PORTUGUESE_BR_R: Key presses will enter Brasilian Portuguese characters as like rapid text entry
AEE_TM_SPANISH_LA: Key presses will enter Latin America Spanish characters as like multitap
AEE_TM_SPANISH_LA_R: Key presses will enter Latin America Spanish characters as like rapid text entry
AEE_TM_DIALED_DIGITS: Key presses will enter characters on a phone keypad
AEE_TM_ENGLISH_UK_R: Key presses will enter United Kingdom English characters as like rapid text entry
AEE_TM_ENGLISH_US: Key presses will enter United States English characters as like multitap
AEE_TM_ENGLISH_US_R: Key presses will enter United States English characters as like rapid text entry
AEE_TM_ENGLISH_UK: Key presses will enter United Kingdom English characters as like multitap

Comments:
The available text entry modes differ with each BREW-enabled device.

See Also:
ITEXTCTL_SetInputMode()

=====================================================================
AEETextInputModeInfo

Description:
This structure contains the an AEETextInputMode and a buffer to hold the 
string that is associated with that mode to be filled when using the 
ITEXTCTL_GetInputMode API.

Definition:
typedef struct _AEETextInputModeInfo
{
   AEETextInputMode  tmMode;
   AECHAR            modeString[MAX_TEXT_MODE_SIZE];
} AEETextInputModeInfo;

Members:
   tmMode;	            Text Mode enum entry
   modeString;	         String that is associated with the mode

Comments:
The available text entry modes differ with each BREW-enabled device.

See Also:
ITEXTCTL_GetInputMode(), AEETextInputMode

=====================================================================
AEE ITextCtl Properties

Description: 
   These are the properties defined for ITextCtl Interface .

Definition:  
TP_MULTILINE     :If set, text control object is multiple line control.
TP_FRAME         :If set, text control object has a frame.
TP_T9_MODE       :(Deprecated)
TP_RAPID_MODE    :Supports Rapid Entry and uses as default
TP_NODRAW        :Disables all drawing by the control
TP_NOUPDATE      :Disables wasteful IDISPLAY_Update() calls
TP_PASSWORD      :Displays ***, manages correct buffer chars
TP_INTEGRALHEIGHT:If set this forces the rectangle of the ITEXTCTL_SetRect() 
                  to be of an even height with respect to the character height. 
                  asically there will be no left over space and the text will 
                  fit naturally into the text control. Rather than showing
                  1.5 lines of text it will show either 1 or 2. It will round to 
                  the nearest line height and snap to it.
TP_FIXSETRECT    :Actual height more closely represents requested height.
TP_FOCUS_NOSEL   :Act like TextCtl 1, do not alter selection on activation [SetActive(TRUE)]. 
                  TextCtl 2 default is OFF. Flag has no effect with AEECLSID_TEXTCTL_10.
TP_OLD_MT_CHARS  :Sets the AEE_TM_LETTERS to use same symbols as TextCtl 1 for AVK_1. 
                  TextCtl 2 default is OFF. Flag has no effect with AEECLSID_TEXTCTL_10.
TP_OVERWRITE	 :Will cause the wildcard character (?) to be selected and overwritten with each
                  character entered
TP_FONTMORPH     :Changes the font from large to small when string reaches the end
                  of the text box
TP_AUTOHYPHEN	 :Will auto hyphen the displayed string to US format.

Members:
None

Comments:
When using TP_PASSWORD and using standard Text methods, you will get actual inputted text
and not the *** used to hide actual text.

See Also:
ITEXTCTL_SetProperties(), ITEXTCTL_GetProperties() 

=====================================================================
   INTERFACE DOCUMENTATION
=======================================================================

ITextCtl Interface

A text control enables the device user to enter a string of text using the keys
on the device. The text control consists of an optional title and a rectangular
window containing one or more lines in which the entered text is displayed to the
device user. The text control handles the translation of device user key presses
into characters. Your application only needs to pass keypress events to the text
control while it is active and retrieve the text from the control when device user
text entry has completed. The translation process depends on the text entry modes
the device supports (for example, the standard multi-tap mode in which the device
user selects from the characters mapped to each key, and Tegic's T9 predictive text
input mode). If more than one text entry mode is supported, your application makes
it possible for the device user to select the specified mode while the text control
is active. The text control allows you to specify a Soft Key menu that is used for
this purpose. While the text control is active, your application must send all keypress
events to it by calling ITEXTCTL_HandleEvent().

Text control 2 is introduced in BREW 3.1.3. It maintains backward binary compatibility
applets compiled using Text control 1. If an applet is compiled against a BREW version
including and above 3.1.3, the newer text control will be picked up. The older behavior
is now described by AEECLSID_TEXTCTL_10 if you wish to keep the older text control. Any
behaviors that were changed as a part of Text control 2 are now properties that may
be unset. This will allow you to take advantage of the newer API while preserving the 
older behavior of the Text control 1. The properties added to text control 2 for emulation
of text control 1 are: TP_FOCUS_NOSEL and TP_OLD_MT_CHARS.

While the Soft Key menu is active, the device user can press the UP key to return
to edit mode without making a menu selection.
===H2>
To use a text control in your application
===/H2>

1.   Call ISHELL_CreateInstance() to create an instance of the text control.

2.   Call ITEXTCTL_SetRect() to specify the screen rectangle that contains the text
control.

3.   If specified, call ITEXTCTL_SetTitle() or ITEXTCTL_SetText() to specify the
control's title and the initial value of its text string.

4.   Call ITEXTCTL_SetProperties() to set any text control properties.

5.   Call ITEXTCTL_SetSoftKeyMenu() to specify the Soft Key menu that is associated
with the text control, if any.

6.   Call ITEXTCTL_SetActive() to activate the text control and draw its contents
on the screen.

7.   While the text control is active, call ITEXTCTL_HandleEvent() to pass it any
key events generated by the user.

8.   When the device user has completed entering text, call ITEXTCTL_GetText() or
ITEXTCTL_GetTextPtr() to retrieve the text the device user has entered. (If you
are using a Soft Key menu, the device user may signal the completion of text entry
with a "Done" item in the menu, or by pressing the SELECT or other key if no Soft
Key menu is present).

9.   Call ITEXTCTL_Release() to free the text control when you no longer need it.


The following header file is required for ITextCtl 

AEEText.h

=============================================================================

ITEXTCTL_AddRef()

Description:
    This function is inherited from IBASE_AddRef(). 

Version:
   Introduced BREW Client 1.0

See Also:
   ITEXTCTL_Release()

======================================================================= 

ITEXTCTL_EnableCommand() 

Description:
    This function is used to enable sending of specified command by the 
    text control object to the shell object upon receiving the event 
    generated by pressing the SELECT key.

Prototype:
    void ITEXTCTL_EnableCommand(ITextCtl * pITextCtl, boolean bEnable, uint16 nCmdId) 

Parameters:
    pITextCtl : Pointer to the ITextCtl Interface object
    bEnable : Boolean value for enable/disable flag
    nCmdId : Command id

Return Value: 
    None

Comments: 
    None

Side Effects: 
    None

Version:
   Introduced BREW Client 1.0

See Also:
    None

=============================================================================

ITEXTCTL_EnumModeInit()

Description:
    This function initializes the mode enumeration mechanism for the test control.
Any time you want to enumerate the text control, this function must be called first.

Prototype:
    void ITEXTCTL_EnumModeInit(ITextCtl * pITextCtl)

Parameters:
    pITextCtl  :  Pointer to the ITextCtl Interface object

Return Value:
    None

Comments:
    None

Version:
   Introduced BREW Client 2.0

See Also:
    None

=============================================================================

ITEXTCTL_EnumNextMode()

Description:
    This function is called to enumerate the text control modes.

Prototype:
    AEETextInputMode ITEXTCTL_EnumNextMode
    (
    ITextCtl * pITextCtl, 
    AEETextInputModeInfo * pmInfo
    )

Parameters:
    pITextCtl  :  Pointer to the ITextCtl Interface object
    pmInfo :  Optional pointer to receive Text Mode Information. If you do not wish
to receive this information, call this function with a NULL value as the second
parameter.

Return Value:
    An enum of type AEETextInputMode to indicate the next input mode.

    If the enumeration is complete AEE_TM_NONE will be returned.

Comments:
    None

Version:
   Introduced BREW Client 2.0

See Also:
    AEETextInputMode

=============================================================================

ITEXTCTL_GetCursorPos()

Description:
    This function gets the position of a cursor in a text control object.

Prototype:
    int32 ITEXTCTL_GetCursorPos(ITextCtl * pITextCtl)

Parameters:
    pITextCtl  :  Pointer to the ITextCtl Interface object

Return Value:
    Absolute position of cursor in text control

    If you set the character position between an element of a grapheme, the position
    will be updated such that it is in the next available character position after the 
    complete grapheme. This means that a call to this will not necessarily match the value
    passed to a previous call to ITEXTCTL_SetCursorPos(). A grapheme is all the characters 
    that compose a complete symbol in a language such as Thai.

Comments:
    None

Version:
   Introduced BREW Client 2.0

See Also:
    ITEXTCTL_SetCursorPos()

=============================================================================

ITEXTCTL_GetInputMode()

Description:
    This function allows the caller to get the selected text input mode and the
string associated with it.

Prototype:
    AEETextInputMode ITEXTCTL_GetInputMode
    (
    ITextCtl *pITextCtl, 
    AEETextInputModeInfo * pmInfo
    )

Parameters:
    pITextCtl  :  [in] :  Pointer to the ITextCtl Interface object
    pmInfo  :  [in/out] :  Input: a pointer to a AEETextInputModeInfo Info structure
to be filled OR can be NULL, so as to not fill a structure and return current mode.
    Output: If a valid pointer is given it is filled with the current mode and the
string associated with that mode.

Return Value:
    An enum of type AEETextInputModeInfo to indicate the input mode set.

Comments:
    If a AEETextInputModeInfo pointer is given the tmMode field, it will match the
return value of this function. The pmInfo field is not required if the callee is
just checking the AEETextInputModeInfo and does not need the string associated with
it.

Version:
   Introduced BREW Client 2.0