API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IDECORATOR_GETWIDGET()

Brew Release
Brew MP 1.0.2
See Also
- IDecorator Interface - IWidget Interface - IDecorator_SetWidget()
Description
This function retrieves the child widget that is wrapped by the decorator, returning this object as a pointer to an IWidget. Once retrieved, an application may use this pointer to directly manipulate the widget wrapped by the decorator. For example, calling this function on a tab widget (itself a decorator) would return a pointer to the content widget wrapped by the tab widget.
Params
pif
[]:
[in] Pointer to the IDecorator object from which the wrapped widget is to be retrieved.
ppiWidget
[]:
[out] Pointer to an IWidget pointer that will be returned by the function, providing access to the widget that is wrapped by the decorator.
Interface
Prototype
  •    void IDecorator_GetWidget(IDecorator *pif, IWidget **ppiWidget);
    
Return
  • A pointer to the widget that is wrapped by the decorator is returned in 'ppiWidget'.
Side Effect
  • None
Comments
The reference count of the returned widget pointed to by 'ppiWidget' will be incremented. The pointer passed in the 'ppiWidget' 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.