Developer

API Reference

IWidget_ReleaseCapture()

Brew Release
Brew MP 1.0.2
See Also
-Model Events
-ReleaseCaptureEvent
Description
This inline method allows a widget to release capture mode. Widget can choose to release capture mode during pointer stream based on a release criteria.
Parameters
  • pif
    []:
    [in] A pointer to the IWidget interface
  • nReleaseReason
    []:
    [in] Reason for releasing the capture. Refer to ReleaseCaptureEvent for more detail on release reasons.
Interface
Prototype
   int   IWidget_ReleaseCapture(IWidget *piw, int nReleaseReason);
Return
   AEE_SUCCESS - If the requested operation was performed successfully( capture mode released)
   AEE_EFAILED - Otherwise
Side Effect
None
Comment
Note that the capure mode functionality actually belongs to RootContainer. This inline function uses IWidget_SetPropertyEx() to release the capture mode on the RootContainer. It is important that the widget be inserted in the RootContainer( directly or via some other container chain) before making this call.
Rootcontainer after releasing the capture mode sends a viewmodel notification EVT_MDL_RELEASE_CAPTURE with releasereason to its listeners.
  • Follow