Show the 'active' and 'deactivate' messages with the layer name in quotes in the...
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / layerlower.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file layerlower.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 "layerlower.h"
33 #include "layermove.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(Action::LayerLower);
49 ACTION_SET_NAME(Action::LayerLower,"layer_lower");
50 ACTION_SET_LOCAL_NAME(Action::LayerLower,N_("Lower Layer"));
51 ACTION_SET_TASK(Action::LayerLower,"lower");
52 ACTION_SET_CATEGORY(Action::LayerLower,Action::CATEGORY_LAYER);
53 ACTION_SET_PRIORITY(Action::LayerLower,10);
54 ACTION_SET_VERSION(Action::LayerLower,"0.0");
55 ACTION_SET_CVS_ID(Action::LayerLower,"$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::LayerLower::LayerLower()
64 {
65 }
66
67 Action::ParamVocab
68 Action::LayerLower::get_param_vocab()
69 {
70         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
71
72         ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
73                 .set_local_name(_("Layer"))
74                 .set_desc(_("Layer to be lowered"))
75                 .set_supports_multiple()
76         );
77
78         return ret;
79 }
80
81 bool
82 Action::LayerLower::is_candidate(const ParamList &x)
83 {
84         if(!candidate_check(get_param_vocab(),x))
85                 return false;
86
87         Layer::Handle layer(x.find("layer")->second.get_layer());
88         //synfig::info("layer->get_depth()= %d ; layer->get_canvas()->size()=%d ;",layer->get_depth(),layer->get_canvas()->size());
89         if(layer->get_depth()+1>=layer->get_canvas()->size())
90                 return false;
91         return true;
92 }
93
94 bool
95 Action::LayerLower::set_param(const synfig::String& name, const Action::Param &param)
96 {
97         if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
98         {
99                 layers.push_back(param.get_layer());
100
101                 return true;
102         }
103
104         return Action::CanvasSpecific::set_param(name,param);
105 }
106
107 bool
108 Action::LayerLower::is_ready()const
109 {
110         if(layers.empty())
111                 return false;
112         return Action::CanvasSpecific::is_ready();
113 }
114
115 void
116 Action::LayerLower::prepare()
117 {
118         std::list<synfig::Layer::Handle>::const_iterator iter;
119
120         clear();
121
122         for(iter=layers.begin();iter!=layers.end();++iter)
123         {
124                 Layer::Handle layer(*iter);
125
126                 Canvas::Handle subcanvas(layer->get_canvas());
127
128                 // Find the iterator for the layer
129                 Canvas::iterator iter=find(subcanvas->begin(),subcanvas->end(),layer);
130
131                 // If we couldn't find the layer in the canvas, then bail
132                 if(*iter!=layer)
133                         throw Error(_("This layer doesn't exist anymore."));
134
135                 // If the subcanvas isn't the same as the canvas,
136                 // then it had better be an inline canvas. If not,
137                 // bail
138                 //if(get_canvas()!=subcanvas && !subcanvas->is_inline())
139                 //      throw Error(_("This layer doesn't belong to this canvas anymore"));
140
141                 int new_index=iter-subcanvas->begin();
142
143                 new_index++;
144
145                 // If this lowers the layer past the bottom then don't bother
146                 if(new_index==subcanvas->size())
147                         continue;
148
149                 Action::Handle layer_move(LayerMove::create());
150
151                 layer_move->set_param("canvas",get_canvas());
152                 layer_move->set_param("canvas_interface",get_canvas_interface());
153                 layer_move->set_param("layer",layer);
154                 layer_move->set_param("new_index",new_index);
155
156                 add_action_front(layer_move);
157         }
158 }