1 /* === S Y N F I G ========================================================= */
2 /*! \file valuedescexport.cpp
3 ** \brief Template File
8 ** Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
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.
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.
21 /* ========================================================================= */
23 /* === H E A D E R S ======================================================= */
32 #include "valuenodeadd.h"
34 #include "canvasadd.h"
35 #include "valuedescexport.h"
36 #include "layerparamconnect.h"
38 #include <synfigapp/canvasinterface.h>
39 #include <synfig/valuenode_const.h>
41 #include <synfigapp/general.h>
47 using namespace synfig;
48 using namespace synfigapp;
49 using namespace Action;
51 /* === M A C R O S ========================================================= */
53 ACTION_INIT_NO_GET_LOCAL_NAME(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$");
62 /* === G L O B A L S ======================================================= */
64 /* === P R O C E D U R E S ================================================= */
66 /* === M E T H O D S ======================================================= */
68 Action::ValueDescExport::ValueDescExport()
73 Action::ValueDescExport::get_local_name()const
75 // TRANSLATORS: This is used in the 'history' dialog when a ValueNode is exported. The first %s is what is exported, the 2nd is the name it is given.
76 return strprintf(_("Export '%s' as '%s'"),
77 value_desc.get_description(false).c_str(),
82 Action::ValueDescExport::get_param_vocab()
84 ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
86 ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
87 .set_local_name(_("ValueDesc"))
90 ret.push_back(ParamDesc("name",Param::TYPE_STRING)
91 .set_local_name(_("Name"))
92 .set_desc(_("The name that you want this value to be exported as"))
100 Action::ValueDescExport::is_candidate(const ParamList &x)
102 if(candidate_check(get_param_vocab(),x))
104 ValueDesc value_desc=x.find("value_desc")->second.get_value_desc();
105 if(!value_desc || value_desc.parent_is_canvas() || (value_desc.is_value_node() && value_desc.get_value_node()->is_exported()))
113 Action::ValueDescExport::set_param(const synfig::String& param_name, const Action::Param ¶m)
115 if(param_name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
117 value_desc=param.get_value_desc();
122 if(param_name=="name" && param.get_type()==Param::TYPE_STRING)
124 name=param.get_string();
129 return Action::CanvasSpecific::set_param(param_name,param);
133 Action::ValueDescExport::is_ready()const
135 if(!value_desc || name.empty())
137 return Action::CanvasSpecific::is_ready();
141 Action::ValueDescExport::prepare()
145 ValueNode::Handle value_node;
147 if(value_desc.get_value_type()==ValueBase::TYPE_CANVAS)
149 if(!value_desc.is_const())
150 throw Error(_("Can only export Canvas when used as constant parameter"));
151 Canvas::Handle canvas(value_desc.get_value().get(Canvas::Handle()));
153 Action::Handle action(CanvasAdd::create());
155 action->set_param("canvas",get_canvas());
156 action->set_param("canvas_interface",get_canvas_interface());
157 action->set_param("src",canvas);
158 action->set_param("id",name);
160 assert(action->is_ready());
161 if(!action->is_ready())
162 throw Error(Error::TYPE_NOTREADY);
164 add_action_front(action);
170 if(value_desc.is_value_node())
172 if(value_desc.get_value_node()->is_exported())
173 throw Error(_("ValueBase is already exported"));
175 value_node=value_desc.get_value_node();
179 if(!value_desc.parent_is_layer_param())
180 throw Error(_("Unable to export parameter. (Bug?)"));
182 value_node=ValueNode_Const::create(value_desc.get_value());
184 Action::Handle action(LayerParamConnect::create());
186 action->set_param("canvas",get_canvas());
187 action->set_param("canvas_interface",get_canvas_interface());
188 action->set_param("layer",value_desc.get_layer());
189 action->set_param("param",value_desc.get_param_name());
190 action->set_param("value_node",value_node);
192 assert(action->is_ready());
193 if(!action->is_ready())
194 throw Error(Error::TYPE_NOTREADY);
196 add_action_front(action);
199 Action::Handle action(ValueNodeAdd::create());
201 action->set_param("canvas",get_canvas());
202 action->set_param("canvas_interface",get_canvas_interface());
203 action->set_param("new",value_node);
204 action->set_param("name",name);
206 assert(action->is_ready());
207 if(!action->is_ready())
208 throw Error(Error::TYPE_NOTREADY);
210 add_action_front(action);