This class implements a command for setting the properties (other than the visibility) of a group.
More...
#include "Group_SetProp.hpp"
|
enum | PropT { PROP_NAME,
PROP_COLOR,
PROP_CANSELECT,
PROP_SELECTASGROUP
} |
|
This class implements a command for setting the properties (other than the visibility) of a group.
CommandGroupSetPropT::CommandGroupSetPropT |
( |
MapDocumentT & |
MapDoc, |
|
|
GroupT * |
Group, |
|
|
const wxString & |
NewName |
|
) |
| |
The constructor for setting a new name.
- Parameters
-
MapDoc | The map document the group is in. |
Group | The group whose property is set. |
NewName | The new name for the group. |
CommandGroupSetPropT::CommandGroupSetPropT |
( |
MapDocumentT & |
MapDoc, |
|
|
GroupT * |
Group, |
|
|
const wxColor & |
NewColor |
|
) |
| |
The constructor for setting a new color.
- Parameters
-
MapDoc | The map document the group is in. |
Group | The group whose property is set. |
NewColor | The new color for the group. If Group->IsVisible is already NewVis, Do() will fail. |
CommandGroupSetPropT::CommandGroupSetPropT |
( |
MapDocumentT & |
MapDoc, |
|
|
GroupT * |
Group, |
|
|
PropT |
Prop, |
|
|
bool |
NewFlag |
|
) |
| |
The constructor for setting a new value for CanSelect or SelectAsGroup.
- Parameters
-
MapDoc | The map document the group is in. |
Group | The group whose property is set. |
Prop | The boolean property that is newly set. Must be either PROP_CANSELECT or PROP_SELECTASGROUP. |
NewFlag | The new value for the above specified boolean properly. |
bool CommandGroupSetPropT::Do |
( |
| ) |
|
|
virtual |
This method executes the command.
- Returns
- true if the command succeeded, false if it failed.
Implements CommandT.
const GroupT* CommandGroupSetPropT::GetGroup |
( |
| ) |
const |
|
inline |
Returns the group whose property is set.
wxString CommandGroupSetPropT::GetName |
( |
| ) |
const |
|
virtual |
Returns the name (a description) of the command.
Implements CommandT.
PropT CommandGroupSetPropT::GetProp |
( |
| ) |
const |
|
inline |
Returns which property is set.
void CommandGroupSetPropT::Undo |
( |
| ) |
|
|
virtual |
This method un-does the command.
Implements CommandT.
The documentation for this class was generated from the following files: