The Battle for Wesnoth  1.15.1+dev
Public Member Functions | List of all members
editor::editor_action_extendable Class Referenceabstract

Base class for actions that: 1) operate on an area 2) can be used as undo for a click-drag operation 3) can be extended so one undo action undos several actual drag actions. More...

#include <action.hpp>

Inheritance diagram for editor::editor_action_extendable:
Inheritance graph

Public Member Functions

 editor_action_extendable ()
 
virtual void extend (const editor_map &map, const std::set< map_location > &locs)=0
 The crux of the extendable contract. More...
 
const std::string & get_name () const
 
- 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...
 

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 actions that: 1) operate on an area 2) can be used as undo for a click-drag operation 3) can be extended so one undo action undos several actual drag actions.

Definition at line 63 of file action.hpp.

Constructor & Destructor Documentation

◆ editor_action_extendable()

editor::editor_action_extendable::editor_action_extendable ( )
inline

Definition at line 66 of file action.hpp.

Member Function Documentation

◆ extend()

virtual void editor::editor_action_extendable::extend ( const editor_map map,
const std::set< map_location > &  locs 
)
pure 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.

Implemented in editor::editor_action_paste, editor::editor_action_area, editor::editor_action_deselect, and editor::editor_action_select.

◆ get_name()

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

Reimplemented from editor::editor_action.

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

Definition at line 78 of file action.hpp.

References name().


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