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_label Class Reference

Set label action. More...

#include <action_label.hpp>

Inheritance diagram for editor::editor_action_label:
Inheritance graph

Public Member Functions

 editor_action_label (map_location loc, const std::string &text, const std::string &team_name, SDL_Color color, bool visible_fog, bool visible_shroud, bool immutable, std::string category)
 
editor_action_labelclone () const
 Action cloning. 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 char * get_name () const
 
- Public Member Functions inherited from editor::editor_action_location
 editor_action_location (map_location loc)
 
- 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...
 

Protected Attributes

const std::string text_
 
const std::string team_name_
 
const std::string category_
 
SDL_Color color_
 
bool visible_fog_
 
bool visible_shroud_
 
bool immutable_
 
- Protected Attributes inherited from editor::editor_action_location
map_location loc_
 

Additional Inherited Members

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

Detailed Description

Set label action.

Definition at line 40 of file action_label.hpp.

Constructor & Destructor Documentation

editor::editor_action_label::editor_action_label ( map_location  loc,
const std::string text,
const std::string team_name,
SDL_Color  color,
bool  visible_fog,
bool  visible_shroud,
bool  immutable,
std::string  category 
)
inline

Definition at line 43 of file action_label.hpp.

Referenced by clone(), and perform().

Member Function Documentation

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

Action cloning.

Implements editor::editor_action.

Definition at line 28 of file action_label.cpp.

References editor_action_label().

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

Reimplemented from editor::editor_action_location.

Definition at line 52 of file action_label.hpp.

editor_action * editor::editor_action_label::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 33 of file action_label.cpp.

References terrain_label::category(), terrain_label::color(), editor_action_label(), map_labels::get_label(), editor::map_context::get_labels(), terrain_label::immutable(), editor::editor_action_location::loc_, perform_without_undo(), terrain_label::team_name(), terrain_label::text(), terrain_label::visible_in_fog(), and terrain_label::visible_in_shroud().

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

Perform the action without creating an undo action.

Implements editor::editor_action.

Definition at line 49 of file action_label.cpp.

References category_, color_, editor::map_context::get_labels(), immutable_, editor::editor_action_location::loc_, map_labels::set_label(), team_name_, text_, visible_fog_, and visible_shroud_.

Referenced by perform().

Member Data Documentation

const std::string editor::editor_action_label::category_
protected

Definition at line 56 of file action_label.hpp.

Referenced by perform_without_undo().

SDL_Color editor::editor_action_label::color_
protected

Definition at line 57 of file action_label.hpp.

Referenced by perform_without_undo().

bool editor::editor_action_label::immutable_
protected

Definition at line 60 of file action_label.hpp.

Referenced by perform_without_undo().

const std::string editor::editor_action_label::team_name_
protected

Definition at line 55 of file action_label.hpp.

Referenced by perform_without_undo().

const std::string editor::editor_action_label::text_
protected

Definition at line 54 of file action_label.hpp.

Referenced by perform_without_undo().

bool editor::editor_action_label::visible_fog_
protected

Definition at line 58 of file action_label.hpp.

Referenced by perform_without_undo().

bool editor::editor_action_label::visible_shroud_
protected

Definition at line 59 of file action_label.hpp.

Referenced by perform_without_undo().


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