editor::editor_action_select Class Reference

Select the given locations. More...

#include <action_select.hpp>

Inheritance diagram for editor::editor_action_select:

Public Member Functions
	editor_action_select (const std::set< map_location > &area)
editor_action_select *	clone () const
	Action cloning. More...
void	extend (const editor_map &map, const std::set< map_location > &locs)
	The crux of the extendable contract. More...
editor_action *	perform (map_context &mc) const
	Perform the action, returning an undo action that, when performed, shall reverse any effects of this action. More...
void	perform_without_undo (map_context &mc) const
	Perform the action without creating an undo action. More...
const char *	get_name () const
Public Member Functions inherited from editor::editor_action_area
	editor_action_area (const std::set< map_location > &area)
Public Member Functions inherited from editor::editor_action_extendable
	editor_action_extendable ()
Public Member Functions inherited from editor::editor_action
	editor_action ()
virtual	~editor_action ()
virtual int	action_count () const
virtual std::string	get_description () const
	A textual description of the action. More...
int	get_id () const
	Debugging aid. More...

Additional Inherited Members
Static Public Member Functions inherited from editor::editor_action
static int	get_instance_count ()
	Debugging aid. More...
Protected Attributes inherited from editor::editor_action_area
std::set< map_location >	area_

Detailed Description

Select the given locations.

Definition at line 37 of file action_select.hpp.

Constructor & Destructor Documentation

editor::editor_action_select::editor_action_select ( const std::set< map_location > &  area )

inline

Definition at line 40 of file action_select.hpp.

Referenced by clone(), and perform().

Member Function Documentation

editor_action_select * editor::editor_action_select::clone ( ) const

virtual

Action cloning.

Implements editor::editor_action.

Definition at line 26 of file action_select.cpp.

References editor_action_select().

void editor::editor_action_select::extend ( const editor_map &  map, const std::set< map_location > &  locs  )

virtual

The crux of the extendable contract.

This member function must be implemented so that the undo behavior is consistent, exactly the same as would be with separate undo actions for every part of the drag.

Reimplemented from editor::editor_action_area.

Definition at line 31 of file action_select.cpp.

References editor::editor_action_area::area_, and LOG_ED.

const char* editor::editor_action_select::get_name ( ) const

inlinevirtual

Returns

a short name of this action type, defaults to unknown

Reimplemented from editor::editor_action_area.

Definition at line 48 of file action_select.hpp.

editor_action * editor::editor_action_select::perform ( map_context &  mc ) const

virtual

Perform the action, returning an undo action that, when performed, shall reverse any effects of this action.

The undo action object is owned by the caller. Default behavior is to create a whole-map undo, call the perform_without_undo function and return the undo object.

Reimplemented from editor::editor_action.

Definition at line 39 of file action_select.cpp.

References editor::map_context::add_changed_location(), editor::editor_action_area::area_, editor_action_select(), and perform_without_undo().

void editor::editor_action_select::perform_without_undo ( map_context &  ) const

virtual

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 50 of file action_select.cpp.

References editor::map_context::add_changed_location(), editor::editor_map::add_to_selection(), editor::editor_action_area::area_, and editor::map_context::get_map().

Referenced by perform().

---

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

• editor/action/action_select.hpp
• editor/action/action_select.cpp