The Battle for Wesnoth  1.15.2+dev
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, color_t color, bool visible_fog, bool visible_shroud, bool immutable, std::string category)
 
editor_action_labelclone () const
 Inherited from editor_action, implemented by IMPLEMENT_ACTION. 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 std::string & get_name () const
 Inherited from editor_action, implemented by IMPLEMENT_ACTION. More...
 
- 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_
 
color_t 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 37 of file action_label.hpp.

Constructor & Destructor Documentation

◆ editor_action_label()

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

Member Function Documentation

◆ clone()

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

Inherited from editor_action, implemented by IMPLEMENT_ACTION.

Implements editor::editor_action.

Referenced by editor_action_label(), and editor::editor_action_label_delete::editor_action_label_delete().

◆ get_name()

const std::string& editor::editor_action_label::get_name ( ) const
virtual

Inherited from editor_action, implemented by IMPLEMENT_ACTION.

Reimplemented from editor::editor_action_location.

Referenced by editor_action_label(), and editor::editor_action_label_delete::editor_action_label_delete().

◆ perform()

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 29 of file action_label.cpp.

References terrain_label::category(), terrain_label::color(), terrain_label::immutable(), loc_, terrain_label::team_name(), terrain_label::text(), terrain_label::visible_in_fog(), and terrain_label::visible_in_shroud().

Referenced by editor_action_label(), and editor::editor_action_label_delete::editor_action_label_delete().

◆ perform_without_undo()

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

Member Data Documentation

◆ category_

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

Definition at line 72 of file action_label.hpp.

Referenced by perform_without_undo().

◆ color_

color_t editor::editor_action_label::color_
protected

Definition at line 74 of file action_label.hpp.

Referenced by perform_without_undo().

◆ immutable_

bool editor::editor_action_label::immutable_
protected

Definition at line 78 of file action_label.hpp.

Referenced by perform_without_undo().

◆ team_name_

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

Definition at line 71 of file action_label.hpp.

Referenced by perform_without_undo().

◆ text_

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

Definition at line 70 of file action_label.hpp.

Referenced by perform_without_undo().

◆ visible_fog_

bool editor::editor_action_label::visible_fog_
protected

Definition at line 76 of file action_label.hpp.

Referenced by perform_without_undo().

◆ visible_shroud_

bool editor::editor_action_label::visible_shroud_
protected

Definition at line 77 of file action_label.hpp.

Referenced by perform_without_undo().


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