The Battle for Wesnoth  1.15.1+dev
Public Member Functions | Protected Attributes | List of all members
editor::editor_action_area Class Reference

Base class for area-affecting actions. More...

#include <action.hpp>

Inheritance diagram for editor::editor_action_area:
Inheritance graph

Public Member Functions

 editor_action_area (const std::set< map_location > &area)
 
void extend (const editor_map &map, const std::set< map_location > &locs)
 The crux of the extendable contract. More...
 
const std::string & get_name () const
 
- 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 editor_actionclone () const =0
 Action cloning. More...
 
virtual editor_actionperform (map_context &) const
 Perform the action, returning an undo action that, when performed, shall reverse any effects of this action. More...
 
virtual void perform_without_undo (map_context &) const =0
 Perform the action without creating an undo action. More...
 
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...
 

Protected Attributes

std::set< map_locationarea_
 

Additional Inherited Members

- Static Public Member Functions inherited from editor::editor_action
static int get_instance_count ()
 Debugging aid. More...
 

Detailed Description

Base class for area-affecting actions.

Definition at line 232 of file action.hpp.

Constructor & Destructor Documentation

◆ editor_action_area()

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

Definition at line 235 of file action.hpp.

Member Function Documentation

◆ extend()

void editor::editor_action_area::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.

Implements editor::editor_action_extendable.

Reimplemented in editor::editor_action_deselect, and editor::editor_action_select.

Definition at line 183 of file action.cpp.

References IMPLEMENT_ACTION.

◆ get_name()

const std::string& editor::editor_action_area::get_name ( ) const
inlinevirtual
Returns
a short name of this action type, defaults to unknown

Reimplemented from editor::editor_action_extendable.

Reimplemented in editor::editor_action_shuffle_area, editor::editor_action_paint_area, editor::editor_action_deselect, and editor::editor_action_select.

Definition at line 242 of file action.hpp.

References name().

Member Data Documentation

◆ area_

std::set<map_location> editor::editor_action_area::area_
protected

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