Developer

API Reference

IForm_GetDecoratorWidget()

Brew Release
Brew MP 1.0.2
Description
This function will retrieve a pointer to the form's decorator widget for those specialized forms that have derived from the base form. For example, the list form defines a list widget (which derives from the decorator widget) to manage list data in an expected and consistent manner. It is important to note that the decorator widget is provided in _addition_ to the form's primary widget accessed by the WID_FORM property. Calling IForm_GetDecoratorWidget() allows an application to access this decorator widget.
Parameters
  • pif
    []:
    [in] Pointer to the IForm interface object.
  • ppif
    []:
    [out] Pointer to an IDecorator pointer, into which the function will return a pointer to the form's decorator widget.
Interface
Prototype
   int IForm_GetDecoratorWidget(IForm *pif, IDecorator **ppif);
Return
AEE_SUCCESS : If the form was able to successfully retrieve the decorator widget. AEE_ECLASSNOTSUPPORT : If the form does not support the use of a dedicated decorator widget.
A pointer to the form's decorator widget is returned in 'ppif'.
Side Effect
Calling IForm_GetDecoratorWidget() effectively queries the form to retrieve the WID_DECORATOR 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.
  • Follow