Added a \todo note questioning a part of the code.
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / canvasadd.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file canvasadd.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 "canvasadd.h"
33 #include <synfigapp/canvasinterface.h>
34
35 #endif
36
37 using namespace std;
38 using namespace etl;
39 using namespace synfig;
40 using namespace synfigapp;
41 using namespace Action;
42
43 /* === M A C R O S ========================================================= */
44
45 ACTION_INIT(Action::CanvasAdd);
46 ACTION_SET_NAME(Action::CanvasAdd,"canvas_add");
47 ACTION_SET_LOCAL_NAME(Action::CanvasAdd,"Add Child Canvas");
48 ACTION_SET_TASK(Action::CanvasAdd,"add");
49 ACTION_SET_CATEGORY(Action::CanvasAdd,Action::CATEGORY_CANVAS);
50 ACTION_SET_PRIORITY(Action::CanvasAdd,0);
51 ACTION_SET_VERSION(Action::CanvasAdd,"0.0");
52 ACTION_SET_CVS_ID(Action::CanvasAdd,"$Id$");
53
54 /* === G L O B A L S ======================================================= */
55
56 /* === P R O C E D U R E S ================================================= */
57
58 /* === M E T H O D S ======================================================= */
59
60 Action::CanvasAdd::CanvasAdd()
61 {
62         set_dirty(true);
63 }
64
65 Action::ParamVocab
66 Action::CanvasAdd::get_param_vocab()
67 {
68         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
69
70         ret.push_back(ParamDesc("src",Param::TYPE_CANVAS)
71                 .set_local_name(_("New Canvas"))
72                 .set_optional()
73         );
74
75         ret.push_back(ParamDesc("id",Param::TYPE_STRING)
76                 .set_local_name(_("ID"))
77                 .set_desc(_("The name that you want this canvas to be"))
78                 .set_user_supplied()
79         );
80
81         return ret;
82 }
83
84 bool
85 Action::CanvasAdd::is_candidate(const ParamList &x)
86 {
87         return candidate_check(get_param_vocab(),x);
88 }
89
90 bool
91 Action::CanvasAdd::set_param(const synfig::String& name, const Action::Param &param)
92 {
93         if(name=="src" && param.get_type()==Param::TYPE_CANVAS)
94         {
95                 new_canvas=param.get_canvas();
96
97                 return true;
98         }
99         if(name=="id" && param.get_type()==Param::TYPE_STRING)
100         {
101                 id=param.get_string();
102
103                 return true;
104         }
105
106         return Action::CanvasSpecific::set_param(name,param);
107 }
108
109 bool
110 Action::CanvasAdd::is_ready()const
111 {
112         return Action::CanvasSpecific::is_ready();
113 }
114
115 void
116 Action::CanvasAdd::perform()
117 {
118         if(!new_canvas)
119         {
120                 new_canvas=get_canvas()->new_child_canvas(id);
121         }
122         else
123         {
124                 if(new_canvas->is_inline())
125                 {
126                         inline_parent=new_canvas->parent();
127                 }
128                 get_canvas()->add_child_canvas(new_canvas,id);
129         }
130
131         if(get_canvas_interface())
132         {
133                 get_canvas_interface()->signal_canvas_added()(new_canvas);
134         }
135         else synfig::warning("CanvasInterface not set on action");
136 }
137
138 void
139 Action::CanvasAdd::undo()
140 {
141         get_canvas()->remove_child_canvas(new_canvas);
142
143         if(inline_parent)
144                 new_canvas->set_inline(inline_parent);
145
146         if(get_canvas_interface())
147         {
148                 get_canvas_interface()->signal_canvas_removed()(new_canvas);
149         }
150         else synfig::warning("CanvasInterface not set on action");
151 }