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

Developer

API Reference

IGRIDCONTAINER_GETVISIBILITY()

Brew Release
Brew MP 1.0.2
See Also
- IGridContainer Interface - IWidget Interface - IGridContainer_SetVisibility()
Description
This function retrieves a widget's visibility as a copy in the parameter 'pbVisible'.
Params
pif
[]:
[in] A pointer to an IGridContainer object.
piw
[]:
[in] Identifies the widget in the grid container's widget stack whose visibility attribute 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 visibility attribute for the default widget, which BREW interprets to be the widget at the top of the widget stack. WIDGET_ZTOPMOST - Retrieve the visibility attribute for the widget at the top of the widget stack. WIDGET_ZBOTTOMMOST - Retrieve the visibility attribute for the widget at the bottom of the widget stack.
pbVisible
[]:
[out] Pointer to a boolean which will be set with a copy of the current visibility attribute of the widget.

Interface
Prototype
  •    int IGridContainer_GetVisibility(IGridContainer* pif,
                                        IWidget* piw,
                                        boolean* pbVisible);
    
Return
  •    
       AEE_SUCCESS   --  The visibility attribute of the widget were successfully retrieved.
       AEE_EBADPARM  --  The widget pointer passed in 'piw' either does not exist, or refers to a
                         widget that is not in the grid container's widget stack.
    

Side Effect
  • None
Comments
None