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

Developer

API Reference

ICONTROLLER_SETVIRTUALINPUTFRAMESTATE()

Brew Release
Brew MP 1.0.2
See Also
IController Interface IController_CreateVirtualInputFrame() IController_ShowVirtualInputFrame() IController_HideVirtualInputFrame() IController_DestroyVirtualInputFrame()
Description
This function is used make the input manager perform some action on the virtual input widget. Refer to the list of possible states below.
Params
pif
[in]:
Pointer to the IController interface object.
nVal
[in]:
Value to set to the property
Interface
Prototype
  •    AEEResult IController_SetVirtualInputFrameState(IController *pif, uint32 nVal)
    
Return
  •    AEE_SUCCESS      --  The value was set successfully
       AEE_EFAILED      --  The value could not be set.
    
Side Effect
  • None
Comments
VIRTUALINPUT_FRAME_CREATE: Create the input widget, but do not display it. Useful for pre-loading the keypad. VIRTUALINPUT_FRAME_SHOW: Display the virtual input widget. If the widget isn't created yet, it will be instantiated. VIRTUALINPUT_FRAME_HIDE: Hide the virtual input widget. This should be called after the user is done inputting data. VIRTUALINPUT_FRAME_DESTROY: Frees the virtual input widget. This should only be called during low memory conditions, or similar extreme cases where it is unfavorable to keep the widget ready to be displayed.