NAME

       BackCmd, FrontCmd, GroupCmd, UngroupCmd - commands for modifying components structurally

SYNOPSIS

       #include <Unidraw/Commands/struct.h>

DESCRIPTION

       BackCmd,  FrontCmd, GroupCmd, and UngroupCmd are purely interpretive commands for altering
       the structure of their editor's component.   All  redefine  their  Execute  and  Unexecute
       operations to let the editor's component interpret them as it wishes.

BACKCMD PUBLIC OPERATIONS

       BackCmd(ControlInfo*)
       BackCmd(Editor* = nil)
              Construct a new BackCmd.

FRONTCMD PUBLIC OPERATIONS

       FrontCmd(ControlInfo*)
       FrontCmd(Editor* = nil)
              Construct a new FrontCmd.

GROUPCMD PUBLIC OPERATIONS

       GroupCmd(ControlInfo*, GraphicComp* = nil)
       GroupCmd(Editor* = nil, GraphicComp* = nil)
              Create  a  new  GroupCmd, optionally specifying the component into which components
              will be grouped.

       virtual void Execute()
       virtual void Unexecute()
              Execute will set the value of the _executed protected member variable to true as  a
              side effect if anything was grouped.  Similarly, Unexecute will set reset the value
              to false as a side effect the operation was undone.

       GraphicComp* GetGroup()
       void SetGroup(GraphicComp*)
              Get or set the component into which components will be grouped.  SetGroup will  not
              delete the old value.

UNGROUPCMD PUBLIC OPERATIONS

       UngroupCmd(ControlInfo*)
       UngroupCmd(Editor* = nil)
              Construct a new UngroupCmd.

       virtual void Execute()
       virtual void Unexecute()
              Execute  will set the value of the _executed protected member variable to true as a
              side effect if anything was ungrouped.  Similarly, Unexecute  will  set  reset  the
              value to false as a side effect the operation was undone.

       Clipboard* GetKids()
       void SetKids(Clipboard*)
              Explicitly  set  and  get  a  clipboard  containing  the child components that were
              ungrouped, which is stored in the _kids  protected  member.   UngroupCmd  does  not
              initialize  this  member;  it  merely  provides  the  storage  as  a convenience to
              components that interpret the command and need  a  place  to  store  the  ungrouped
              children  to  support reverse execution.  However, UngroupCmd deletes the clipboard
              (if it exists) in ~UngroupCmd. SetKids will not delete the old value.

SEE ALSO

       Command(3U), GraphicComp(3U)