Developer

API Reference

IGridContainer_SetVisibility()

Brew Release
Brew MP 1.0.2
See Also
IGridContainer Interface IWidget Interface IGridContainer_GetVisibility()
Description
This function will change the visibility attributes of a given widget, and will optionally relocate that widget to a different location in the grid container's widget stack. The widget to receive the new visibility may be specified explicitly by its widget pointer, or implicitly by a constant that identifies the widget's relative position within the container's widget stack. The 'pb' parameter controls whether or not the widget's location in the stack will move. Passing the constant WIDGET_ZNORMAL leaves the widget where it currently stands, without altering the order of the stack. Passing WIDGET_ZTOPMOST or WIDGET_ZBOTTOMMOST will move the widget to the top or bottom of the stack, while passing an explicit widget pointer will move the target widget to the stack location before the widget passed in 'pb'.
Parameters
  • p
    []:
    A pointer to an IGridContainer object.
  • piw
    []:
    Identifies the widget in the grid container's widget stack that will be the target of the visibility change and (optionally) relocation. 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 - The target widget is the default widget, which BREW interprets to be the widget at the top of the widget stack. WIDGET_ZTOPMOST - The target widget is the widget at the top of the widget stack. WIDGET_ZBOTTOMMOST - The target widget is the widget at the bottom of the widget stack.
  • piwBefore
    []:
    Identifies a widget in the grid container's widget stack that will serve as the relocation spot for the target widget. When this parameter is passed as an explicit pointer to a widget in the container's widget stack, the target widget will be moved to the stack location that is _before_ this widget. The new location for the target widget may be passed implicitly as a relative location in the stack by passing any of the following constants. WIDGET_ZNORMAL - Specifies that the target widget should NOT be moved and should instead remain at its current location in the widget stack. WIDGET_ZTOPMOST - The target widget should be moved to the top of the widget stack. WIDGET_ZBOTTOMMOST - The target widget should be moved to the bottom of the widget stack.
  • pbVisible
    []:
    Pointer to a boolean, containing the new visibility value for the target widget.

Prototype
   int IGridContainer_SetVisibility(IGridContainer* pif, IWidget* piw, IWidget* piwBefore, const boolean* pbVisible)
   int IGridContainer_SetVisibility(IGridContainer *p, IWidget *pw, IWidget *pb, const boolean *pv);
Return
   
   AEE_SUCCESS   --  The visibility attribute of the widget were successfully changed.
   AEE_EBADPARM  --  The widget pointers passed in 'pw' and/or 'pb' either do not exist, or
                     refer to widgets that are not in the grid container's widget stack.

Side Effect
The cell size is still determined as if the widget were being drawn to the screen. Setting a widget to not visible simply means it does not draw.
Comment
If IGridContainer_SetVisibility() is being called to change the location of the widget within the grid container's widget stack without changing the visibility attributes of the widget, the caller MUST still pass in a pointer to the correct visibility attributes in the 'pv' parameter. In such cases, the application should first call IGridContainer_GetVisibility() to retrieve the current visibility attributes, then call IGridContainer_SetVisibility() passing back the results received from IGridContainer_GetVisibility().
  • Follow