Fix missing back slash to do not stop all the extra dist files list
[synfig.git] / synfig-studio / src / synfigapp / actions / layersetdesc.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file layersetdesc.cpp
3 **      \brief Template File
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **      Copyright (c) 2008 Chris Moore
10 **
11 **      This package is free software; you can redistribute it and/or
12 **      modify it under the terms of the GNU General Public License as
13 **      published by the Free Software Foundation; either version 2 of
14 **      the License, or (at your option) any later version.
15 **
16 **      This package is distributed in the hope that it will be useful,
17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
19 **      General Public License for more details.
20 **      \endlegal
21 */
22 /* ========================================================================= */
23
24 /* === H E A D E R S ======================================================= */
25
26 #ifdef USING_PCH
27 #       include "pch.h"
28 #else
29 #ifdef HAVE_CONFIG_H
30 #       include <config.h>
31 #endif
32
33 #include "layersetdesc.h"
34 #include <synfigapp/canvasinterface.h>
35
36 #include <synfigapp/general.h>
37
38 #endif
39
40 using namespace std;
41 using namespace etl;
42 using namespace synfig;
43 using namespace synfigapp;
44 using namespace Action;
45
46 /* === M A C R O S ========================================================= */
47
48 ACTION_INIT_NO_GET_LOCAL_NAME(Action::LayerSetDesc);
49 ACTION_SET_NAME(Action::LayerSetDesc,"LayerSetDesc");
50 ACTION_SET_LOCAL_NAME(Action::LayerSetDesc,N_("Set Layer Description"));
51 ACTION_SET_TASK(Action::LayerSetDesc,"set_desc");
52 ACTION_SET_CATEGORY(Action::LayerSetDesc,Action::CATEGORY_LAYER);
53 ACTION_SET_PRIORITY(Action::LayerSetDesc,0);
54 ACTION_SET_VERSION(Action::LayerSetDesc,"0.0");
55 ACTION_SET_CVS_ID(Action::LayerSetDesc,"$Id$");
56
57 /* === G L O B A L S ======================================================= */
58
59 static const int nindex=-1;
60
61 /* === P R O C E D U R E S ================================================= */
62
63 /* === M E T H O D S ======================================================= */
64
65 Action::LayerSetDesc::LayerSetDesc()
66 {
67 }
68
69 synfig::String
70 Action::LayerSetDesc::get_local_name()const
71 {
72         return strprintf("%s: '%s' -> '%s'",
73                                          _("Set Layer Description"),
74                                          /* TRANSLATORS: this is the string used in the history dialog when renaming a layer to/from its default name */
75                                          old_description.empty() ? _("[default]") : old_description.c_str(),
76                                          new_description.empty() ? _("[default]") : new_description.c_str());
77 }
78
79 Action::ParamVocab
80 Action::LayerSetDesc::get_param_vocab()
81 {
82         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
83
84         ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
85                 .set_local_name(_("Layer"))
86                 .set_desc(_("Layer to be moved"))
87         );
88
89         ret.push_back(ParamDesc("new_description",Param::TYPE_STRING)
90                 .set_local_name(_("New Description"))
91                 .set_local_name(_("Enter a new description for this layer"))
92                 .set_user_supplied()
93         );
94
95         return ret;
96 }
97
98 bool
99 Action::LayerSetDesc::is_candidate(const ParamList &x)
100 {
101         return candidate_check(get_param_vocab(),x);
102 }
103
104 bool
105 Action::LayerSetDesc::set_param(const synfig::String& name, const Action::Param &param)
106 {
107         if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
108         {
109                 layer=param.get_layer();
110
111                 return true;
112         }
113
114         if(name=="new_description" && param.get_type()==Param::TYPE_STRING)
115         {
116                 new_description=param.get_string();
117
118                 return true;
119         }
120
121         return Action::CanvasSpecific::set_param(name,param);
122 }
123
124 bool
125 Action::LayerSetDesc::is_ready()const
126 {
127         if(!layer)
128                 return false;
129         return Action::CanvasSpecific::is_ready();
130 }
131
132 void
133 Action::LayerSetDesc::perform()
134 {
135         old_description=layer->get_description();
136         layer->set_description(new_description);
137         set_dirty(false);
138         if(get_canvas_interface())
139         {
140                 get_canvas_interface()->signal_layer_new_description()(layer,new_description);
141         }
142         else synfig::warning("CanvasInterface not set on action");
143 }
144
145 void
146 Action::LayerSetDesc::undo()
147 {
148         layer->set_description(old_description);
149         set_dirty(false);
150         if(get_canvas_interface())
151         {
152                 get_canvas_interface()->signal_layer_new_description()(layer,old_description);
153         }
154         else synfig::warning("CanvasInterface not set on action");
155 }