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

Developer

API Reference

IROOTCONTAINER_GETPOS()

Brew Release
Brew MP 1.0.2
See Also
- IRootContainer Interface - IWidget Interface - WidgetPos - IRootContainer_SetPos()
Description
This function retrieves a widget's layout position within the root container, returning a copy of that widget's layout position and visibility attribute in the WidgetPos data structure pointed to by 'ppos'.
Params
pif
[]:
A pointer to an IRootContainer object.
pw
[]:
Identifies the widget in the root container's widget stack whose layout position should be retrieved. This widget may be expressed explicitly as a widget pointer, or implicitly as a constant that identifies a relative position within the widget stack, as
ppos
[]:
Pointer to a WidgetPos data structure, into which the function will copy the current layout position of the widget.

Interface
Prototype
  •    int IRootContainer_GetPos(IRootContainer *pif, IWidget *pw, WidgetPos *ppos);
    
Return
  •    
       AEE_SUCCESS   --  The layout position of the widget was successfully retrieved.
       AEE_EBADPARM  --  The widget pointer passed in 'pw' either does not exist, or refers to a
                     widget that is not in the root container's widget stack.
    

Side Effect
  • None
Comments
None