Developer

API Reference

IForm_GetWidget()

Brew Release
Brew MP 1.0.2
See Also
IForm IForm_GetTitleWidget() IForm_GetSoftWidget() IForm_GetBGWidget() IForm_GetProgressWidget() IForm_GetDecoratorWidget() IForm_SetWidget() IWidget Widget Events
Description
This function will retrieve a pointer to a particular child widget contained within a form. For example, an application could call IForm_GetWidget(), passing in WID_SOFTKEYS to retrieve a pointer to the form's softkey widget.
Parameters
  • pif
    []:
    [in] Pointer to the IForm interface object.
  • wid
    []:
    [in] Widget ID specifying the widget to be retrieved.
  • ppif
    []:
    [out] Pointer to an IWidget pointer, into which the function will return a pointer to the requested widget.
Interface
Prototype
   int IForm_GetWidget(IForm *pif, uint16 wid, IWidget **ppif)
Return
AEE_SUCCESS : If the form was able to successfully retrieve the requested widget AEE_ECLASSNOTSUPPORT : If the requested widget was not recognized by the form.
Side Effect
Calling IForm_GetWidget() effectively queries the form to retrieve the requested widget as a property.
Comment
The pointer passed in the 'ppif' parameter is a double-indirection -- i.e. it is a pointer to a pointer. Applications should use care in ensuring that the proper level of indirection is used in calling the function.
IForm_GetWidget() is the base "widget getter" for a form. Applications are encouraged to use the more specific IForm_GetxxxxxxWidget() functions when retrieving a form's widgets.
  • Follow