Developer

API Reference

IWidget_SetTouchMode()

Brew Release
Brew MP 1.0.2
See Also
IWidget Widget Events IWidget_SetPropertyEx IWidget_GetTouchMode
Description
This routine is used to set the touch mode for the specified widget. Touch Mode can be
AEEWIDGET_TOUCH_MODE_ALWAYS - Can always take a touch event AEEWIDGET_TOUCH_MODE_NEVER - Can never take a touch event AEEWIDGET_TOUCH_MODE_TRANSPARENCY - Can take a touch event depending on the transperency value at a given co-ordinate. AEEWIDGET_TOUCH_MODE_CHILD - Only its child widget can take touch events depending on the child widget's touch mode. Touch events on a coordinate which does not have a child widget will never be handled. AEEWIDGET_TOUCH_MODE_BORDER - This mode is a mix between touch mode always and touch mode transparency. The border of the widget is treated as if it had touch mode transparency; however, the widget content is treated as if it were touch mode always. Not all widgets support all modes. For example, widgets that do not have child widgets do not support AEEWIDGET_TOUCH_MODE_CHILD. If a touch mode is not supported, this call will fail and the current touch mode will be preserved. The touch mode of widget elements (like the handle widget) is independent of the touch mode of their parent (scrollbar widget)
Parameters
  • pif
    []:
    [in] Pointer to the IWidget interface object
  • nTouchMode
    []:
    [in] Touch Mode to be set for the specified widget.
Interface
Prototype
   int IWidget_SetTouchMode(IWidget* pif, int nTouchMode);
Return
   AEE_SUCCESS - If the widget is able to set the requested property.
   AEE_EFAILED - If the property could not be set.
Side Effect
None
Comment
NOTE: AEECLSID_ListWidget is a special type of decorator. In a ListWidget the child widget does not have a notion of a position within the decorator. Hence the ListWidget does not support 'AEEWIDGET_TOUCH_MODE_CHILD' for this property.
  • Follow