The Battle for Wesnoth  1.15.2+dev
Public Member Functions | List of all members
editor::editor_action_deselect Class Reference

Deselect the given locations. More...

#include <action_select.hpp>

Inheritance diagram for editor::editor_action_deselect:
Inheritance graph

Public Member Functions

 editor_action_deselect (const std::set< map_location > &area)
 
editor_action_deselectclone () const
 Inherited from editor_action, implemented by IMPLEMENT_ACTION. More...
 
void extend (const editor_map &map, const std::set< map_location > &locs)
 The crux of the extendable contract. More...
 
editor_actionperform (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 std::string & get_name () const
 Inherited from editor_action, implemented by IMPLEMENT_ACTION. More...
 
- 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

Deselect the given locations.

Definition at line 59 of file action_select.hpp.

Constructor & Destructor Documentation

◆ editor_action_deselect()

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

Member Function Documentation

◆ clone()

editor_action_deselect* editor::editor_action_deselect::clone ( ) const
virtual

Inherited from editor_action, implemented by IMPLEMENT_ACTION.

Implements editor::editor_action.

◆ extend()

void editor::editor_action_deselect::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 58 of file action_select.cpp.

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

◆ get_name()

const std::string& editor::editor_action_deselect::get_name ( ) const
virtual

Inherited from editor_action, implemented by IMPLEMENT_ACTION.

Reimplemented from editor::editor_action_area.

◆ perform()

editor_action * editor::editor_action_deselect::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 69 of file action_select.cpp.

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

◆ perform_without_undo()

void editor::editor_action_deselect::perform_without_undo ( map_context ) const
virtual

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