Typo: 'totaly' -> 'totally'.
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / groupremovelayers.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file groupremovelayers.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 "groupremovelayers.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::GroupRemoveLayers);
46 ACTION_SET_NAME(Action::GroupRemoveLayers,"group_remove_layers");
47 ACTION_SET_LOCAL_NAME(Action::GroupRemoveLayers,"Remove Layers from a Group");
48 ACTION_SET_TASK(Action::GroupRemoveLayers,"remove");
49 ACTION_SET_CATEGORY(Action::GroupRemoveLayers,Action::CATEGORY_LAYER|Action::CATEGORY_GROUP);
50 ACTION_SET_PRIORITY(Action::GroupRemoveLayers,0);
51 ACTION_SET_VERSION(Action::GroupRemoveLayers,"0.0");
52 ACTION_SET_CVS_ID(Action::GroupRemoveLayers,"$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::GroupRemoveLayers::GroupRemoveLayers()
61 {
62 }
63
64 Action::ParamVocab
65 Action::GroupRemoveLayers::get_param_vocab()
66 {
67         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
68
69         ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
70                 .set_local_name(_("Layer"))
71                 .set_desc(_("Layer to be added to group"))
72                 .set_supports_multiple()
73         );
74
75         ret.push_back(ParamDesc("group",Param::TYPE_STRING)
76                 .set_local_name(_("Group"))
77                 .set_desc(_("Name of the Group to add the Layers to"))
78                 .set_user_supplied()
79         );
80
81         return ret;
82 }
83
84 bool
85 Action::GroupRemoveLayers::is_candidate(const ParamList &x)
86 {
87         return candidate_check(get_param_vocab(),x);
88 }
89
90 bool
91 Action::GroupRemoveLayers::set_param(const synfig::String& name, const Action::Param &param)
92 {
93         if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
94         {
95                 std::pair<synfig::Layer::Handle,String> layer_pair;
96                 layer_pair.first=param.get_layer();
97                 layer_list.push_back(layer_pair);
98
99                 return true;
100         }
101
102         if(name=="group" && param.get_type()==Param::TYPE_STRING)
103         {
104                 group=param.get_string();
105
106                 return true;
107         }
108
109         return Action::CanvasSpecific::set_param(name,param);
110 }
111
112 bool
113 Action::GroupRemoveLayers::is_ready()const
114 {
115         if(layer_list.empty() || group.empty())
116                 return false;
117         return Action::CanvasSpecific::is_ready();
118 }
119
120 void
121 Action::GroupRemoveLayers::perform()
122 {
123         std::list<std::pair<synfig::Layer::Handle,String> >::iterator iter;
124         for(iter=layer_list.begin();iter!=layer_list.end();++iter)
125         {
126                 Layer::Handle layer(iter->first);
127                 iter->second=layer->get_group();
128
129                 layer->remove_from_group(group);
130         }
131 }
132
133 void
134 Action::GroupRemoveLayers::undo()
135 {
136         std::list<std::pair<synfig::Layer::Handle,String> >::iterator iter;
137         for(iter=layer_list.begin();iter!=layer_list.end();++iter)
138         {
139                 Layer::Handle layer(iter->first);
140
141                 layer->add_to_group(iter->second);
142         }
143 }