Show the 'active' and 'deactivate' messages with the layer name in quotes in the...
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / valuedescexport.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file valuedescexport.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 "valuenodeadd.h"
33
34 #include "canvasadd.h"
35 #include "valuedescexport.h"
36 #include "layerparamconnect.h"
37
38 #include <synfigapp/canvasinterface.h>
39 #include <synfig/valuenode_const.h>
40
41 #include <synfigapp/general.h>
42
43 #endif
44
45 using namespace std;
46 using namespace etl;
47 using namespace synfig;
48 using namespace synfigapp;
49 using namespace Action;
50
51 /* === M A C R O S ========================================================= */
52
53 ACTION_INIT(Action::ValueDescExport);
54 ACTION_SET_NAME(Action::ValueDescExport,"value_desc_export");
55 ACTION_SET_LOCAL_NAME(Action::ValueDescExport,N_("Export"));
56 ACTION_SET_TASK(Action::ValueDescExport,"export");
57 ACTION_SET_CATEGORY(Action::ValueDescExport,Action::CATEGORY_VALUEDESC);
58 ACTION_SET_PRIORITY(Action::ValueDescExport,0);
59 ACTION_SET_VERSION(Action::ValueDescExport,"0.0");
60 ACTION_SET_CVS_ID(Action::ValueDescExport,"$Id$");
61
62 /* === G L O B A L S ======================================================= */
63
64 /* === P R O C E D U R E S ================================================= */
65
66 /* === M E T H O D S ======================================================= */
67
68 Action::ValueDescExport::ValueDescExport()
69 {
70 }
71
72 Action::ParamVocab
73 Action::ValueDescExport::get_param_vocab()
74 {
75         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
76
77         ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
78                 .set_local_name(_("ValueDesc"))
79         );
80
81         ret.push_back(ParamDesc("name",Param::TYPE_STRING)
82                 .set_local_name(_("Name"))
83                 .set_desc(_("The name that you want this value to be exported as"))
84                 .set_user_supplied()
85         );
86
87         return ret;
88 }
89
90 bool
91 Action::ValueDescExport::is_candidate(const ParamList &x)
92 {
93         if(candidate_check(get_param_vocab(),x))
94         {
95                 ValueDesc value_desc=x.find("value_desc")->second.get_value_desc();
96                 if(!value_desc || value_desc.parent_is_canvas() || (value_desc.is_value_node() && value_desc.get_value_node()->is_exported()))
97                         return false;
98                 return true;
99         }
100         return false;
101 }
102
103 bool
104 Action::ValueDescExport::set_param(const synfig::String& param_name, const Action::Param &param)
105 {
106         if(param_name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
107         {
108                 value_desc=param.get_value_desc();
109
110                 return true;
111         }
112
113         if(param_name=="name" && param.get_type()==Param::TYPE_STRING)
114         {
115                 name=param.get_string();
116
117                 return true;
118         }
119
120         return Action::CanvasSpecific::set_param(param_name,param);
121 }
122
123 bool
124 Action::ValueDescExport::is_ready()const
125 {
126         if(!value_desc || name.empty())
127                 return false;
128         return Action::CanvasSpecific::is_ready();
129 }
130
131 void
132 Action::ValueDescExport::prepare()
133 {
134         clear();
135
136         ValueNode::Handle value_node;
137
138         if(value_desc.get_value_type()==ValueBase::TYPE_CANVAS)
139         {
140                 if(!value_desc.is_const())
141                         throw Error(_("Can only export Canvas when used as constant parameter"));
142                 Canvas::Handle canvas(value_desc.get_value().get(Canvas::Handle()));
143
144                 Action::Handle action(CanvasAdd::create());
145
146                 action->set_param("canvas",get_canvas());
147                 action->set_param("canvas_interface",get_canvas_interface());
148                 action->set_param("src",canvas);
149                 action->set_param("id",name);
150
151                 assert(action->is_ready());
152                 if(!action->is_ready())
153                         throw Error(Error::TYPE_NOTREADY);
154
155                 add_action_front(action);
156
157                 return;
158         }
159
160
161         if(value_desc.is_value_node())
162         {
163                 if(value_desc.get_value_node()->is_exported())
164                         throw Error(_("ValueBase is already exported"));
165
166                 value_node=value_desc.get_value_node();
167         }
168         else
169         {
170                 if(!value_desc.parent_is_layer_param())
171                         throw Error(_("Unable to export parameter. (Bug?)"));
172
173                 value_node=ValueNode_Const::create(value_desc.get_value());
174
175                 Action::Handle action(LayerParamConnect::create());
176
177                 action->set_param("canvas",get_canvas());
178                 action->set_param("canvas_interface",get_canvas_interface());
179                 action->set_param("layer",value_desc.get_layer());
180                 action->set_param("param",value_desc.get_param_name());
181                 action->set_param("value_node",value_node);
182
183                 assert(action->is_ready());
184                 if(!action->is_ready())
185                         throw Error(Error::TYPE_NOTREADY);
186
187                 add_action_front(action);
188         }
189
190         Action::Handle action(ValueNodeAdd::create());
191
192         action->set_param("canvas",get_canvas());
193         action->set_param("canvas_interface",get_canvas_interface());
194         action->set_param("new",value_node);
195         action->set_param("name",name);
196
197         assert(action->is_ready());
198         if(!action->is_ready())
199                 throw Error(Error::TYPE_NOTREADY);
200
201         add_action_front(action);
202 }