Use get_layer_descriptions() to format the layer list rather than including a copy...
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / valuenoderename.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file valuenoderename.cpp
3 **      \brief Template File
4 **
5 **      $Id$
6 **
7 **      \legal
8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
9 **
10 **      This package is free software; you can redistribute it and/or
11 **      modify it under the terms of the GNU General Public License as
12 **      published by the Free Software Foundation; either version 2 of
13 **      the License, or (at your option) any later version.
14 **
15 **      This package is distributed in the hope that it will be useful,
16 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
17 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 **      General Public License for more details.
19 **      \endlegal
20 */
21 /* ========================================================================= */
22
23 /* === H E A D E R S ======================================================= */
24
25 #ifdef USING_PCH
26 #       include "pch.h"
27 #else
28 #ifdef HAVE_CONFIG_H
29 #       include <config.h>
30 #endif
31
32 #include "valuenoderename.h"
33 #include <synfigapp/canvasinterface.h>
34
35 #include <synfigapp/general.h>
36
37 #endif
38
39 using namespace std;
40 using namespace etl;
41 using namespace synfig;
42 using namespace synfigapp;
43 using namespace Action;
44
45 /* === M A C R O S ========================================================= */
46
47 ACTION_INIT_NO_GET_LOCAL_NAME(Action::ValueNodeRename);
48 ACTION_SET_NAME(Action::ValueNodeRename,"value_node_rename");
49 ACTION_SET_LOCAL_NAME(Action::ValueNodeRename,N_("Rename ValueNode"));
50 ACTION_SET_TASK(Action::ValueNodeRename,"rename");
51 ACTION_SET_CATEGORY(Action::ValueNodeRename,Action::CATEGORY_VALUENODE);
52 ACTION_SET_PRIORITY(Action::ValueNodeRename,0);
53 ACTION_SET_VERSION(Action::ValueNodeRename,"0.0");
54 ACTION_SET_CVS_ID(Action::ValueNodeRename,"$Id$");
55
56 /* === G L O B A L S ======================================================= */
57
58 /* === P R O C E D U R E S ================================================= */
59
60 /* === M E T H O D S ======================================================= */
61
62 Action::ValueNodeRename::ValueNodeRename()
63 {
64 }
65
66 synfig::String
67 Action::ValueNodeRename::get_local_name()const
68 {
69         // TRANSLATORS: This is used in the 'history' dialog when a ValueNode is renamed.
70         return strprintf(_("Rename ValueNode from '%s' to '%s'"),
71                                          old_name.c_str(),
72                                          new_name.c_str());
73 }
74
75 Action::ParamVocab
76 Action::ValueNodeRename::get_param_vocab()
77 {
78         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
79
80         ret.push_back(ParamDesc("value_node",Param::TYPE_VALUENODE)
81                 .set_local_name(_("ValueNode_Const"))
82         );
83
84         ret.push_back(ParamDesc("name",Param::TYPE_STRING)
85                 .set_local_name(_("Name"))
86                 .set_desc(_("The new name of the ValueNode"))
87                 .set_user_supplied()
88         );
89
90         return ret;
91 }
92
93 bool
94 Action::ValueNodeRename::is_candidate(const ParamList &x)
95 {
96         if(candidate_check(get_param_vocab(),x))
97         {
98                 if(x.find("value_node")->second.get_value_node()->is_exported())
99                         return true;
100         }
101         return false;
102 }
103
104 bool
105 Action::ValueNodeRename::set_param(const synfig::String& name, const Action::Param &param)
106 {
107         if(name=="value_node" && param.get_type()==Param::TYPE_VALUENODE)
108         {
109                 value_node=param.get_value_node();
110
111                 if(value_node && !value_node->is_exported())
112                 {
113                         synfig::error("Action::ValueNodeRename::set_param(): ValueBase node not exported!");
114                         value_node=0;
115                 }
116
117                 return (bool)value_node;
118         }
119
120         if(name=="name" && param.get_type()==Param::TYPE_STRING)
121         {
122                 new_name=param.get_string();
123
124                 return true;
125         }
126
127         return Action::CanvasSpecific::set_param(name,param);
128 }
129
130 bool
131 Action::ValueNodeRename::is_ready()const
132 {
133         if(!value_node)
134                 synfig::error("Action::ValueNodeRename::is_ready(): ValueNode not set!");
135
136         if(new_name.empty())
137                 synfig::error("Action::ValueNodeRename::is_ready(): ValueNode not set!");
138
139         if(!value_node || new_name.empty())
140                 return false;
141         return Action::CanvasSpecific::is_ready();
142 }
143
144 void
145 Action::ValueNodeRename::perform()
146 {
147         assert(value_node->is_exported());
148
149         if(get_canvas()->value_node_list().count(new_name))
150                 throw Error(_("A ValueNode with this ID already exists in this canvas"));
151
152         old_name=value_node->get_id();
153
154         value_node->set_id(new_name);
155
156         if(get_canvas_interface())
157         {
158                 get_canvas_interface()->signal_value_node_renamed()(value_node);
159         }
160 }
161
162 void
163 Action::ValueNodeRename::undo()
164 {
165         assert(value_node->is_exported());
166
167         if(get_canvas()->value_node_list().count(old_name))
168                 throw Error(_("A ValueNode with the old ID already exists in this canvas (BUG)"));
169
170         value_node->set_id(old_name);
171
172         if(get_canvas_interface())
173         {
174                 get_canvas_interface()->signal_value_node_renamed()(value_node);
175         }
176 }