a35cf97775fcb10254916b820eb270277da781a4
[synfig.git] /
1 /* === S Y N F I G ========================================================= */
2 /*!     \file canvasidset.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 "canvasidset.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::CanvasIdSet);
49 ACTION_SET_NAME(Action::CanvasIdSet,"canvas_id_set");
50 ACTION_SET_LOCAL_NAME(Action::CanvasIdSet,N_("Set Canvas Id"));
51 ACTION_SET_TASK(Action::CanvasIdSet,"set");
52 ACTION_SET_CATEGORY(Action::CanvasIdSet,Action::CATEGORY_CANVAS);
53 ACTION_SET_PRIORITY(Action::CanvasIdSet,0);
54 ACTION_SET_VERSION(Action::CanvasIdSet,"0.0");
55 ACTION_SET_CVS_ID(Action::CanvasIdSet,"$Id$");
56
57 /* === G L O B A L S ======================================================= */
58
59 /* === P R O C E D U R E S ================================================= */
60
61 /* === M E T H O D S ======================================================= */
62
63 Action::CanvasIdSet::CanvasIdSet()
64 {
65 }
66
67 synfig::String
68 Action::CanvasIdSet::get_local_name()const
69 {
70         // TRANSLATORS: This is used in the 'history' dialog when a Canvas has its id changed.
71         return strprintf(_("Change canvas id from '%s' to '%s'"),
72                                          old_id.c_str(),
73                                          new_id.c_str());
74 }
75
76 Action::ParamVocab
77 Action::CanvasIdSet::get_param_vocab()
78 {
79         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
80
81         ret.push_back(ParamDesc("id",Param::TYPE_STRING)
82                 .set_local_name(_("Id"))
83         );
84
85         return ret;
86 }
87
88 bool
89 Action::CanvasIdSet::is_candidate(const ParamList &x)
90 {
91         return candidate_check(get_param_vocab(),x);
92 }
93
94 bool
95 Action::CanvasIdSet::set_param(const synfig::String& id, const Action::Param &param)
96 {
97         if(id=="id" && param.get_type()==Param::TYPE_STRING)
98         {
99                 new_id=param.get_string();
100
101                 return true;
102         }
103
104         return Action::CanvasSpecific::set_param(id,param);
105 }
106
107 bool
108 Action::CanvasIdSet::is_ready()const
109 {
110         if(new_id.empty())
111         {
112                 synfig::error("Action::CanvasIdSet::is_ready(): Id not set!");
113                 return false;
114         }
115
116         return Action::CanvasSpecific::is_ready();
117 }
118
119 void
120 Action::CanvasIdSet::perform()
121 {
122         old_id=get_canvas()->get_id();
123
124         get_canvas()->set_id(new_id);
125
126         if(get_canvas_interface())
127                 get_canvas_interface()->signal_id_changed()();
128         else
129                 synfig::warning("CanvasInterface not set on action");
130 }
131
132 void
133 Action::CanvasIdSet::undo()
134 {
135         get_canvas()->set_id(old_id);
136
137         if(get_canvas_interface())
138                 get_canvas_interface()->signal_id_changed()();
139         else
140                 synfig::warning("CanvasInterface not set on action");
141 }