API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IFORM_SETSOFTKEYS()

Brew Release
Brew MP 1.0.2
See Also
IForm Widget Events
Description
This function sets or clears the text to be displayed in each of the two softkey widgets that appear on a form, setting the text (when present) from strings appearing in a BREW resource file.
Params
pif
[]:
[in] Pointer to the IForm interface object.
pszResFile
[]:
[in] Identifies the name of the resource file that contains the resource that contains softkey strings.
idSoftkey1
[]:
[in] Identifies the resource ID of the string to be displayed in softkey one, or zero to clear the text appearing in softkey one.
idSoftkey2
[]:
[in] Identifies the resource ID of the string to be displayed in softkey two, or zero to clear the text appearing in softkey two.
Interface
Prototype
  •    int IForm_SetSoftkeys(IForm *pif, const char *pszResFile, uint16 idSoftkey1, uint16 idSoftkey2); 
    
Return
  • AEE_SUCCESS : If the form is able to set the softkey text for both softkeys. Note, however, that this does NOT mean that BREW was able to successfully retrieve the text for both softkeys from the resource file. Applications should be certain that 'pszResFile' is a valid BREW resource file and that the 'idSoftkey1' and 'idSoftkey2' resources actually exists. AEE_EFAILED : If the softkey text could not be set.
Side Effect
  • Calling IForm_SetSoftkeys() will send a pair of EVT_WDG_SETPROPERTY events to the form, the first requesting that the FID_SOFTKEY1 property be set, while the second sets FID_SOFTKEY2.
Comments
Applications should exercise care in calling IForm_SetSoftkeys(), making sure that the specified resource file and resources actually exist.