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

Developer

API Reference

IDECORATOR_GETPARENT()

Brew Release
Brew MP 1.0.2
See Also
- IDecorator - IContainer - IDecorator_SetParent() - IWidget_GetParent()
Description
This function retrieves a pointer to the container object that serves as the parent to the decorator. Objects within the widget framework maintain a hierarchy of parent/child relationships, wherein a container may enclose and manage one or more child objects. The children of a parent container may be widgets, or additional containers and decorators, with each child receiving events and being managed by its parent.
IDecorator_GetParent() inherits wholly from IWIDGET_GetParent().
Params
p
[]:
[in] Pointer to the IDecorator object.
ppc
[]:
[out] Pointer to an IContainer pointer, into which IDecorator_GetParent() will return a pointer to the container that serves as the decorator's parent.
Interface
Prototype
  •    void IDecorator_GetParent(IDecorator *p, IContainer **ppc);
       
Return
  • A pointer to the decorator's parent container is returned in 'ppc', or NULL if the decorator does not have a parent container.
Side Effect
  • None
Comments
The pointer passed in the 'ppc' 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.