Detailed Description

A command for clearing the current set of selected objects.

See constructor for details.

Public Member Functions
	CmdClearSelection (const std::string &name="")

Public Member Functions inherited from CmdSelection
	CmdSelection (int cmd, const std::string &name="")

	CmdSelection (int cmd, ImoId id, const std::string &name="")

int	get_cursor_update_policy () override

int	get_undo_policy () override

int	get_selection_update_policy () override

Public Member Functions inherited from DocCmdSimple
virtual	~DocCmdSimple ()

bool	is_composite () override

Public Member Functions inherited from DocCommand
virtual	~DocCommand ()

std::string	get_name ()

bool	is_reversible ()

bool	is_recordable ()

std::string	get_error ()

Additional Inherited Members
Public Types inherited from CmdSelection
enum	ESelectionAction

Public Types inherited from DocCommand
enum	ECmdCursorPolicy

enum	ECmdUndoPolicy

enum	ECmdSelectionPolicy

Constructor & Destructor Documentation

CmdClearSelection::CmdClearSelection ( const std::string & name = "" )

inline

This command clears the set of selected objects.

Parameters

name	The displayable name for the command. If not specified or empty will be replaced by "Selection: clear selection".

Remarks

After executing the command:
- the selection will be empty.
- the cursor will not change its position.

This command is just a convenience class for a CmdSelection command using the parameter k_clear.