Developer

API Reference

IWidget_SetTextLimit()

Brew Release
Brew MP 1.0.2
See Also
- IWidget
- IWidget_SetProperty
- IWidget_GetTextLimit
Description
This function is used to place a limit on the number of characters that may be entered into a text widget. For example, a Magic Number Guessing application might provide a text widget that asks the user to guess a number between 0 and 100, thereby limiting the user's input to two characters. The application would set this limit by passing 2 to IWidget_SetTextLimit() and the attached text controller would then limit the user's ability to enter more than just two characters.
Parameters
  • pif
    []:
    [in] Pointer to the text widget object.
  • nMaxChars
    []:
    [in] Specifies the maximum number of characters that may be entered into the text widget.
Interface
Prototype
   int IWidget_SetTextLimit(IWidget *pif, int nMaxChars)
Return
   AEE_SUCCESS - If BREW was able to successfully set the maximum number of characters for the
                 text widget.
   AEE_EFAILED - If the maximum number of characters for the widget could not be set.
Side Effect
None
Comment
None
  • Follow