CommandGroupSetVisibilityT Class Reference

This class implements a command for setting the visibility status of a group. More...

#include "Group_SetVisibility.hpp"

Inheritance diagram for CommandGroupSetVisibilityT:

Public Member Functions
	CommandGroupSetVisibilityT (MapDocumentT &MapDoc, GroupT *Group, bool NewVis)
	The constructor. More...
	~CommandGroupSetVisibilityT ()
	The destructor. More...
const GroupT *	GetGroup () const
	Returns the group whose visibility is set. 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 setting the visibility status of a group.

The current selection is automatically reduced to visible elements only, that is, selected map elements that are hidden become automatically unselected.

Constructor & Destructor Documentation

CommandGroupSetVisibilityT::CommandGroupSetVisibilityT	(	MapDocumentT &	MapDoc,
		GroupT *	Group,
		bool	NewVis
	)

The constructor.

Parameters

MapDoc	The map document the group is in.
Group	The group whose visibility is set.
NewVis	The new visibility status for the group. If Group->IsVisible is already NewVis, Do() will fail.

CommandGroupSetVisibilityT::~CommandGroupSetVisibilityT

(

)

The destructor.

Member Function Documentation

bool CommandGroupSetVisibilityT::Do ( )

virtual

This method executes the command.

Returns

true if the command succeeded, false if it failed.

Implements CommandT.

const GroupT* CommandGroupSetVisibilityT::GetGroup ( ) const

inline

Returns the group whose visibility is set.

wxString CommandGroupSetVisibilityT::GetName ( ) const

virtual

Returns the name (a description) of the command.

Implements CommandT.

void CommandGroupSetVisibilityT::Undo ( )

virtual

This method un-does the command.

Implements CommandT.

---

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

• CaWE/MapEditor/Commands/Group_SetVisibility.hpp
• CaWE/MapEditor/Commands/Group_SetVisibility.cpp