Developer

API Reference

IContainer_Remove()

Brew Release
Brew MP 1.0.2
See Also
- IContainer Interface
- IWidget Interface
- IContainer_Insert()
Description
This function allows an application to remove a widget from the 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. Some containers may not support removing widgets.
Parameters
  • p
    []:
    A pointer to an IContainer object.
  • pw
    []:
    Identifies the widget that should be removed from the 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
Interface
Prototype
   int IContainer_Remove(IContainer *p, IWidget *pw);
Return
   
   AEE_SUCCESS   --  The widget was successfully removed from the 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 container's widget stack.
   EUNSUPPORTED  --  The widget does not support removal of contained widgets. 

Side Effect
Calling IContainer_Remove() may cause derived containers to adjust their widgets layout
Comment
None
  • Follow