Cafu Engine
CommandDeleteGroupT Class Reference

This class implements a command for deleting one or more groups from the map document. More...

#include "Group_Delete.hpp"

Inheritance diagram for CommandDeleteGroupT:

Public Member Functions

 CommandDeleteGroupT (MapDocumentT &MapDoc, GroupT *Group)
 The constructor for deleting a single group. More...
 
 CommandDeleteGroupT (MapDocumentT &MapDoc, const ArrayT< GroupT * > &Groups)
 The constructor for deleting multiple groups at once. More...
 
 ~CommandDeleteGroupT ()
 The destructor. More...
 
bool Do ()
 This method executes the command. More...
 
void Undo ()
 This method un-does the command. More...
 
wxString GetName () const
 Returns the name (a description) of the command. More...
 
- Public Member Functions inherited from CommandT
 CommandT (bool ShowInHistory=true, bool SuggestsSave=true)
 The constructor. More...
 
virtual ~CommandT ()
 The virtual destructor. More...
 
bool ShowInHistory () const
 Whether the command should be shown in the undo/redo history. More...
 
bool SuggestsSave () const
 Whether the command suggests to save the document when its closed and hasn't been saved between the command execution and the closing (selection changes for example don't suggest to save the document since no important changes have been made). More...
 
bool IsDone () const
 Whether the command has been executed. More...
 
unsigned long GetID () const
 Returns the commands unique ID. More...
 

Additional Inherited Members

- Protected Attributes inherited from CommandT
bool m_Done
 Whether the command has been executed. More...
 
const bool m_ShowInHistory
 Whether the command should have an entry in the undo/redo history. More...
 
const bool m_SuggestsSave
 Whether the command suggests saving of the document on close. More...
 
const unsigned long m_ID
 The commands unique ID. More...
 

Detailed Description

This class implements a command for deleting one or more groups from the map document.

Any members of the deleted group(s) are assigned the NULL (no) group. The counterpart to this class is CommandNewGroupT.

Constructor & Destructor Documentation

CommandDeleteGroupT::CommandDeleteGroupT ( MapDocumentT MapDoc,
GroupT Group 
)

The constructor for deleting a single group.

Parameters
MapDocThe map document to delete the group from.
GroupThe group to be deleted from the map document.
CommandDeleteGroupT::CommandDeleteGroupT ( MapDocumentT MapDoc,
const ArrayT< GroupT * > &  Groups 
)

The constructor for deleting multiple groups at once.

Parameters
MapDocThe map document to delete the groups from.
GroupsThe groups to be deleted from the map document.
CommandDeleteGroupT::~CommandDeleteGroupT ( )

The destructor.

Member Function Documentation

bool CommandDeleteGroupT::Do ( )
virtual

This method executes the command.

Returns
true if the command succeeded, false if it failed.

Implements CommandT.

wxString CommandDeleteGroupT::GetName ( ) const
virtual

Returns the name (a description) of the command.

Implements CommandT.

void CommandDeleteGroupT::Undo ( )
virtual

This method un-does the command.

Implements CommandT.


The documentation for this class was generated from the following files: