Developer

API Reference

IWidget_GetItemWidget()

Brew Release
Brew MP 1.0.2
See Also
- IWidget_ReleaseItemWidget
- EVT_MDL_IDX_WIDGET_CHANGE
Description
This function retrieves a pointer to the item widget at a certain index in a list container widget. This function allows applications to modify the visual appearance (like the background color) of a widget in response to actions such as the user touching an item. When the application is done with the widget it must release the widget, the releasing of the widget is not done through a call to IWidget_Release, instead the user must call IWidget_ReleaseItemWidget on the ListContainer widget with a pointer to the item widget to release.
If the application gets a EVT_MDL_IDX_WIDGET_CHANGE model change notification, then there has been a possible change to the widget/index assignments in the ListContainer, so all previously acquired widgets (acquired using IWidget_GetItemWidget) should be released with the IWidget_ReleaseItemWidget function.
Parameters
  • pif
    []:
    [in] Pointer to the IWidget interface object.
  • nIndex
    []:
    [in] Index of item widget.
  • ppiw
    []:
    [out] Pointer to IWidget *, this will hold the item widget.
Prototype
   int IWidget_GetItemWidget(IWidget *pif, int nIndex, IWidget **ppiw);
Return
   AEE_SUCCESS     - Item widget was successfully retrieved..
   AEE_EFAILED     - Item widget was not retrieved.
Side Effect
None
Comment
None
  • Follow