Developer

API Reference

IForm_SetWidget()

Brew Release
Brew MP 1.0.2
See Also
IForm IForm_GetWidget() IWidget Widget Events
Description
This function will attach a widget to a form as one of the form's primary, common widgets -- title, soktkey, etc... For example, an application that wishes to change a form's title widget could call IForm_SetWidget() specifying WID_TITLE as the widget ID. Attempts to set a widget that is not supported by a particular form will result in no assignment and AEE_ECLASSNOTSUPPORT being returned by the function. For example, attempting to set FID_SOFTKEY1 on a form that is not designed to provide softkeys would result in a failure.
Parameters
  • pif
    []:
    [in] Pointer to the IForm interface object.
  • wid
    []:
    [in] Widget ID specifying the widget to be set.
  • ppif
    []:
    [in] Pointer to the IWidget that will function as the 'wid' widget on this form.
Interface
Prototype
   int IForm_SetWidget(IForm *pif, uint16 wid, IWidget *ppif)
Return
AEE_SUCCESS : If the form was able to successfully set the widget. AEE_ECLASSNOTSUPPORT : If the passed widget is not supported by the form.
Side Effect
If successful, the widget will be stored in the parameter given by the provided widget ID.
Comment
None
  • Follow