1be95498ba5ee465a5f8a3528b85ecd079f380ec
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / layerremove.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file layerremove.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 "layerremove.h"
33 #include <synfigapp/canvasinterface.h>
34
35 #include <synfigapp/general.h>
36
37 #endif
38
39 using namespace std;
40 using namespace etl;
41 using namespace synfig;
42 using namespace synfigapp;
43 using namespace Action;
44
45 /* === M A C R O S ========================================================= */
46
47 ACTION_INIT_NO_GET_LOCAL_NAME(Action::LayerRemove);
48 ACTION_SET_NAME(Action::LayerRemove,"layer_remove");
49 ACTION_SET_LOCAL_NAME(Action::LayerRemove,N_("Remove Layer"));
50 ACTION_SET_TASK(Action::LayerRemove,"remove");
51 ACTION_SET_CATEGORY(Action::LayerRemove,Action::CATEGORY_LAYER);
52 ACTION_SET_PRIORITY(Action::LayerRemove,0);
53 ACTION_SET_VERSION(Action::LayerRemove,"0.0");
54 ACTION_SET_CVS_ID(Action::LayerRemove,"$Id$");
55
56 /* === G L O B A L S ======================================================= */
57
58 /* === P R O C E D U R E S ================================================= */
59
60 /* === M E T H O D S ======================================================= */
61
62 Action::LayerRemove::LayerRemove()
63 {
64 }
65
66 synfig::String
67 Action::LayerRemove::get_local_name()const
68 {
69         return get_layer_descriptions(layer_list, _("Remove Layer"), _("Remove Layers"));
70 }
71
72 Action::ParamVocab
73 Action::LayerRemove::get_param_vocab()
74 {
75         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
76
77         ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
78                 .set_local_name(_("Layer"))
79                 .set_desc(_("Layer to be deleted"))
80                 .set_supports_multiple()
81         );
82
83         return ret;
84 }
85
86 bool
87 Action::LayerRemove::is_candidate(const ParamList &x)
88 {
89         return candidate_check(get_param_vocab(),x);
90 }
91
92 bool
93 Action::LayerRemove::set_param(const synfig::String& name, const Action::Param &param)
94 {
95         if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
96         {
97                 std::pair<synfig::Layer::Handle,int> layer_pair;
98                 layer_pair.first=param.get_layer();
99                 layer_list.push_back(layer_pair);
100
101                 return true;
102         }
103
104         return Action::CanvasSpecific::set_param(name,param);
105 }
106
107 bool
108 Action::LayerRemove::is_ready()const
109 {
110         if(layer_list.empty())
111                 return false;
112         return Action::CanvasSpecific::is_ready();
113 }
114
115 void
116 Action::LayerRemove::perform()
117 {
118         std::list<std::pair<synfig::Layer::Handle,int> >::iterator iter;
119         for(iter=layer_list.begin();iter!=layer_list.end();++iter)
120         {
121                 Layer::Handle layer(iter->first);
122 //              int& depth(iter->second);
123                 Canvas::Handle subcanvas(layer->get_canvas());
124
125                 // Find the iterator for the layer
126                 Canvas::iterator iter2=find(subcanvas->begin(),subcanvas->end(),layer);
127
128                 // If we couldn't find the layer in the canvas, then bail
129                 if(*iter2!=layer)
130                 {
131                         /*!     \todo We should really undo all prior removals
132                         **      before we go throwing shit around */
133                         throw Error(_("This layer doesn't exist anymore."));
134                 }
135
136                 // If the subcanvas isn't the same as the canvas,
137                 // then it had better be an inline canvas. If not,
138                 // bail
139                 if(get_canvas()!=subcanvas && !subcanvas->is_inline())
140                 {
141                         /*!     \todo We should really undo all prior removals
142                         **      before we go throwing shit around */
143                         throw Error(_("This layer doesn't belong to this canvas anymore"));
144                 }
145
146                 set_canvas(subcanvas);
147
148                 // Calculate the depth that the layer was at (For the undo)
149                 iter->second=layer->get_depth();
150
151                 // Mark ourselves as dirty if necessary
152                 set_dirty(layer->active());
153
154                 // Remove the layer from the canvas
155                 subcanvas->erase(iter2);
156
157                 // Signal that a layer has been removed
158                 if(get_canvas_interface())
159                         get_canvas_interface()->signal_layer_removed()(layer);
160         }
161 }
162
163 void
164 Action::LayerRemove::undo()
165 {
166         std::list<std::pair<synfig::Layer::Handle,int> >::reverse_iterator iter;
167         for(iter=layer_list.rbegin();iter!=layer_list.rend();++iter)
168         {
169                 Layer::Handle layer(iter->first);
170                 int& depth(iter->second);
171
172                 // Set the layer's canvas
173                 layer->set_canvas(get_canvas());
174
175                 // Make sure that the depth is valid
176                 if(get_canvas()->size()<depth)
177                         depth=get_canvas()->size();
178
179                 // Mark ourselves as dirty if necessary
180                 set_dirty(layer->active());
181
182                 // Insert the layer into the canvas at the desired depth
183                 get_canvas()->insert(get_canvas()->begin()+depth,layer);
184
185                 // Signal that a layer has been inserted
186                 if(get_canvas_interface())
187                         get_canvas_interface()->signal_layer_inserted()(layer,depth);
188         }
189 }