Developer

API Reference

IXYContainer_GetPos()

Brew Release
Brew MP 1.0.2
See Also
- IXYContainer Interface
- IWidget Interface
- WidgetPos
- IXYContainer_SetPos()
Description
This function retrieves a widget's layout position within the XY container, returning a copy of the layout position and visibility attribute in the WidgetPos data structure pointed to by 'ppos'.
Parameters
  • pif
    []:
    A pointer to an IXYContainer object.
  • pw
    []:
    Identifies the widget in the XY 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 follows. WIDGET_ZNORMAL - Retrieve the layout position for the default widget, which BREW interprets to be the widget at the top of the widget stack. WIDGET_ZTOPMOST - Retrieve the layout position for the widget at the top of the widget stack. WIDGET_ZBOTTOMMOST - Retrieve the layout position for the widget at the bottom of the widget stack.
  • ppos
    []:
    Pointer to a WidgetPos data structure, into which the function will copy the current layout position of the widget.

Interface
Prototype
   int IXYContainer_GetPos(IXYContainer *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 XY container's widget stack.

Side Effect
None
Comment
None
  • Follow