Public Member Functions | Protected Attributes

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
[legend]
Collaboration diagram for editor::editor_action_area:
Collaboration graph
[legend]

List of all members.

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.
const char * get_name () const

Protected Attributes

std::set< map_locationarea_

Detailed Description

Base class for area-affecting actions.

Definition at line 209 of file action.hpp.


Constructor & Destructor Documentation

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

Definition at line 212 of file action.hpp.


Member Function Documentation

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 behaviour 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_select, and editor::editor_action_deselect.

Definition at line 149 of file action.cpp.

const char* editor::editor_action_area::get_name (  )  const [inline, virtual]
Returns:
a short name of this action type, defaults to unknown

Reimplemented from editor::editor_action_extendable.

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

Definition at line 217 of file action.hpp.


Member Data Documentation


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines

Generated by doxygen 1.7.1 on Thu May 24 2012 01:19:24 for The Battle for Wesnoth
Gna! | Forum | Wiki | CIA | devdocs