Developer

API Reference

IPropContainer_GetProp()

Brew Release
Brew MP 1.0.2
See Also
IPropContainer Interface IWidget Interface WidgetProp IPropContainer_SetProp()
Description
This function retrieves a widget's proportional attributes, returning a copy of those values in the WidgetProp data structure pointed to by 'pProp'. The data returned in 'pProp' will include the widget's proportional layout value, as well as its current visibility attribute.
Parameters
  • pif
    []:
    A pointer to an IPropContainer object.
  • pw
    []:
    Identifies the widget in the prop container's widget stack whose proportional attributes 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 proportional attributes for the default widget, which BREW interprets to be the widget at the top of the widget stack. WIDGET_ZTOPMOST - Retrieve the proportional attributes for the widget at the top of the widget stack. WIDGET_ZBOTTOMMOST - Retrieve the proportional attributes for the widget at the bottom of the widget stack.
  • pProp
    []:
    Pointer to a WidgetProp data structure, into which the function will copy the current proportional attributes of the widget.

Prototype
   int IPropContainer_GetProp(IPropContainer* pif, IWidget* pw, WidgetProp* pProp)
Return
   
   AEE_SUCCESS   --  The proportional attributes of the widget were successfully retrieved.
   AEE_EBADPARM  --  The widget pointer passed in 'pw' either does not exist, or refers to a
                     widget that is not in the prop container's widget stack.

Side Effect
None
Comment
None
  • Follow