Developer

API Reference

IConstraintContainer_Remove()

Brew Release
Brew MP 1.0.2
See Also
- IConstraintContainer
- IWidget
- IConstraintContainer_Insert
Description
This function allows an application to remove a widget from the constraint container's widget stack. The widget to be removed 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.
Parameters
  • pif
    []:
    A pointer to an IConstraintContainer object.
  • pw
    []:
    Identifies the widget that should be removed from the constraint container's widget stack. 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 - Remove the default widget, which BREW interprets to be the widget at the top of the widget stack. WIDGET_ZTOPMOST - Remove the widget at the top of the widget stack. WIDGET_ZBOTTOMMOST - Remove the widget at the bottom of the widget stack.

Prototype
   int IConstraintContainer_Remove(IConstraintContainer *pif, IWidget *pw);
Return
   
   AEE_SUCCESS   --  The widget was successfully removed from the constraint container's widget
                     stack.
   AEE_EBADPARM  --  The widget pointer passed in 'pw' either does not exist, or refers to a widget
                     that is not in the constraint container's widget stack.

Side Effect
Calling IConstraintContainer_Remove() will cause the constraint container to adjust the object layout to consume the space surrendered by the removed widget.
Comment
None
  • Follow