The Battle for Wesnoth  1.17.0-dev
Public Member Functions | List of all members
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)
 
std::unique_ptr< editor_actionclone () const override
 Action cloning. More...
 
void extend (const editor_map &map, const std::set< map_location > &locs) override
 The crux of the extendable contract. More...
 
std::unique_ptr< editor_actionperform (map_context &mc) const override
 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 override
 Perform the action without creating an undo action. More...
 
const std::string & get_name () const override
 
- 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_locationarea_
 

Detailed Description

Select the given locations.

Definition at line 36 of file action_select.hpp.

Constructor & Destructor Documentation

◆ editor_action_select()

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

Definition at line 39 of file action_select.hpp.

References clone(), extend(), get_name(), perform(), and perform_without_undo().

Member Function Documentation

◆ clone()

std::unique_ptr<editor_action> editor::editor_action_select::clone ( ) const
overridevirtual

◆ extend()

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

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 29 of file action_select.cpp.

References LOG_ED.

Referenced by editor::editor_action_deselect::editor_action_deselect(), and editor_action_select().

◆ get_name()

const std::string& editor::editor_action_select::get_name ( ) const
overridevirtual

◆ perform()

std::unique_ptr< editor_action > editor::editor_action_select::perform ( map_context mc) const
overridevirtual

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 37 of file action_select.cpp.

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

Referenced by editor::editor_action_deselect::editor_action_deselect(), editor_action_select(), editor::editor_action_select_all::editor_action_select_all(), editor::editor_action_select_inverse::editor_action_select_inverse(), and editor::editor_action_select_none::editor_action_select_none().

◆ perform_without_undo()

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

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