The Battle for Wesnoth  1.13.4+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | Protected Attributes | List of all members
editor::editor_action_whole_map Class Reference

Replace contents of the entire map, Useful as a fallback undo method when something else would be impractical. More...

#include <action.hpp>

Inheritance diagram for editor::editor_action_whole_map:
Inheritance graph

Public Member Functions

 editor_action_whole_map (const editor_map &m)
 
editor_action_whole_mapclone () const
 Action cloning. More...
 
void perform_without_undo (map_context &m) const
 Perform the action without creating an undo action. More...
 
const char * get_name () const
 
- Public Member Functions inherited from editor::editor_action
 editor_action ()
 
virtual ~editor_action ()
 
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 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

editor_map m_
 

Additional Inherited Members

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

Detailed Description

Replace contents of the entire map, Useful as a fallback undo method when something else would be impractical.

Definition at line 38 of file action.hpp.

Constructor & Destructor Documentation

editor::editor_action_whole_map::editor_action_whole_map ( const editor_map m)
inline

Definition at line 41 of file action.hpp.

Referenced by clone().

Member Function Documentation

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

Action cloning.

Implements editor::editor_action.

Definition at line 67 of file action.cpp.

References editor_action_whole_map().

const char* editor::editor_action_whole_map::get_name ( ) const
inlinevirtual
Returns
a short name of this action type, defaults to unknown

Reimplemented from editor::editor_action.

Definition at line 47 of file action.hpp.

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

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 71 of file action.cpp.

References m_, and editor::map_context::set_map().

Member Data Documentation

editor_map editor::editor_action_whole_map::m_
protected

Definition at line 49 of file action.hpp.

Referenced by perform_without_undo().


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