Developer

API Reference

IRootContainer_GetFirstWidget()

Brew Release
Brew MP 1.0.2
See Also
- IRootContainer Interface
- IWidget Interface
- IRootContainer_GetWidget()
- IRootContainer_GetLastWidget()
Description
This function retrieves a pointer to the first widget in the root container's widget stack. This is, effectively, the widget at the top of the widget stack. The widget on the top of the stack is the first one drawn onscreen and is the bottommost with regard to front-to-back ordering within the container.
Parameters
  • pif
    []:
    A pointer to an IRootContainer object.

Prototype
   IWidget *IRootContainer_GetFirstWidget(IRootContainer *pif);
Return
A pointer to the widget at the top of the root container's widget stack, or NULL when the widget stack is empty.
Side Effect
None
Comment
Though IRootContainer_GetFirstWidget() function returns a pointer to a widget, the function does not add a reference to the returned IWidget for the caller.
  • Follow