1 /* === S Y N F I G ========================================================= */
2 /*! \file canvasdescriptionset.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 <synfig/general.h>
34
35 #include "canvasdescriptionset.h"
36 #include <synfigapp/canvasinterface.h>
37
38 #include <synfigapp/localization.h>
39
40 #endif
41
42 using namespace std;
43 using namespace etl;
44 using namespace synfig;
45 using namespace synfigapp;
46 using namespace Action;
47
48 /* === M A C R O S ========================================================= */
49
50 ACTION_INIT_NO_GET_LOCAL_NAME(Action::CanvasDescriptionSet);
51 ACTION_SET_NAME(Action::CanvasDescriptionSet,"CanvasDescriptionSet");
52 ACTION_SET_LOCAL_NAME(Action::CanvasDescriptionSet,N_("Set Canvas Description"));
53 ACTION_SET_TASK(Action::CanvasDescriptionSet,"set");
54 ACTION_SET_CATEGORY(Action::CanvasDescriptionSet,Action::CATEGORY_CANVAS);
55 ACTION_SET_PRIORITY(Action::CanvasDescriptionSet,0);
56 ACTION_SET_VERSION(Action::CanvasDescriptionSet,"0.0");
57 ACTION_SET_CVS_ID(Action::CanvasDescriptionSet,"$Id$");
58
59 /* === G L O B A L S ======================================================= */
60
61 /* === P R O C E D U R E S ================================================= */
62
63 /* === M E T H O D S ======================================================= */
64
CanvasDescriptionSet()65 Action::CanvasDescriptionSet::CanvasDescriptionSet()
66 {
67 }
68
69 synfig::String
get_local_name() const70 Action::CanvasDescriptionSet::get_local_name()const
71 {
72 // TRANSLATORS: This is used in the 'history' dialog when a Canvas has its description changed.
73 return strprintf(_("Change canvas description from '%s' to '%s'"),
74 old_description.c_str(),
75 new_description.c_str());
76 }
77
78 Action::ParamVocab
get_param_vocab()79 Action::CanvasDescriptionSet::get_param_vocab()
80 {
81 ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
82
83 ret.push_back(ParamDesc("description",Param::TYPE_STRING)
84 .set_local_name(_("Description"))
85 );
86
87 return ret;
88 }
89
90 bool
is_candidate(const ParamList & x)91 Action::CanvasDescriptionSet::is_candidate(const ParamList &x)
92 {
93 return candidate_check(get_param_vocab(),x);
94 }
95
96 bool
set_param(const synfig::String & description,const Action::Param & param)97 Action::CanvasDescriptionSet::set_param(const synfig::String& description, const Action::Param ¶m)
98 {
99 if(description=="description" && param.get_type()==Param::TYPE_STRING)
100 {
101 new_description=param.get_string();
102
103 return true;
104 }
105
106 return Action::CanvasSpecific::set_param(description,param);
107 }
108
109 bool
is_ready() const110 Action::CanvasDescriptionSet::is_ready()const
111 {
112 if(new_description.empty())
113 {
114 synfig::error("Action::CanvasDescriptionSet::is_ready(): Description not set!");
115 return false;
116 }
117
118 return Action::CanvasSpecific::is_ready();
119 }
120
121 void
perform()122 Action::CanvasDescriptionSet::perform()
123 {
124 old_description=get_canvas()->get_description();
125
126 get_canvas()->set_description(new_description);
127
128 if(get_canvas_interface())
129 get_canvas_interface()->signal_id_changed()();
130 else
131 synfig::warning("CanvasInterface not set on action");
132 }
133
134 void
undo()135 Action::CanvasDescriptionSet::undo()
136 {
137 get_canvas()->set_description(old_description);
138
139 if(get_canvas_interface())
140 get_canvas_interface()->signal_id_changed()();
141 else
142 synfig::warning("CanvasInterface not set on action");
143 }
144