Added a \todo note questioning a part of the code.
[synfig.git] / synfig-studio / trunk / src / synfigapp / actions / valuenodedynamiclistremove.cpp
1 /* === S Y N F I G ========================================================= */
2 /*!     \file valuenodedynamiclistremove.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 "valuenodedynamiclistremove.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::ValueNodeDynamicListRemove);
46 ACTION_SET_NAME(Action::ValueNodeDynamicListRemove,"value_node_dynamic_list_remove");
47 ACTION_SET_LOCAL_NAME(Action::ValueNodeDynamicListRemove,"Remove Item");
48 ACTION_SET_TASK(Action::ValueNodeDynamicListRemove,"remove");
49 ACTION_SET_CATEGORY(Action::ValueNodeDynamicListRemove,Action::CATEGORY_VALUEDESC|Action::CATEGORY_VALUENODE|Action::CATEGORY_HIDDEN);
50 ACTION_SET_PRIORITY(Action::ValueNodeDynamicListRemove,-19);
51 ACTION_SET_VERSION(Action::ValueNodeDynamicListRemove,"0.0");
52 ACTION_SET_CVS_ID(Action::ValueNodeDynamicListRemove,"$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::ValueNodeDynamicListRemove::ValueNodeDynamicListRemove()
61 {
62         index=0;
63         set_dirty(true);
64 }
65
66 Action::ParamVocab
67 Action::ValueNodeDynamicListRemove::get_param_vocab()
68 {
69         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
70
71         ret.push_back(ParamDesc("value_desc",Param::TYPE_VALUEDESC)
72                 .set_local_name(_("ValueDesc"))
73         );
74
75         return ret;
76 }
77
78 bool
79 Action::ValueNodeDynamicListRemove::is_candidate(const ParamList &x)
80 {
81         if(candidate_check(get_param_vocab(),x))
82         {
83                 ValueDesc value_desc(x.find("value_desc")->second.get_value_desc());
84                 if(!value_desc.parent_is_value_node() || !ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node()))
85                         return false;
86
87                 return true;
88         }
89         return false;
90 }
91
92 bool
93 Action::ValueNodeDynamicListRemove::set_param(const synfig::String& name, const Action::Param &param)
94 {
95         if(name=="value_desc" && param.get_type()==Param::TYPE_VALUEDESC)
96         {
97                 ValueDesc value_desc(param.get_value_desc());
98
99                 if(!value_desc.parent_is_value_node())
100                         return false;
101
102                 value_node=ValueNode_DynamicList::Handle::cast_dynamic(value_desc.get_parent_value_node());
103
104                 if(!value_node)
105                         return false;
106
107                 index=value_desc.get_index();
108
109                 return true;
110         }
111
112         return Action::CanvasSpecific::set_param(name,param);
113 }
114
115 bool
116 Action::ValueNodeDynamicListRemove::is_ready()const
117 {
118         if(!value_node)
119                 return false;
120         return Action::CanvasSpecific::is_ready();
121 }
122
123 void
124 Action::ValueNodeDynamicListRemove::perform()
125 {
126         if(index>=value_node->link_count())
127                 index=value_node->link_count()-1;
128
129         list_entry=value_node->list[index];
130         value_node->erase((value_node->list.begin()+index)->value_node);
131
132         // Signal that a layer has been inserted
133         value_node->changed();
134 /*_if(get_canvas_interface())
135         {
136                 get_canvas_interface()->signal_value_node_changed()(value_node);
137         }
138         else synfig::warning("CanvasInterface not set on action");*/
139 }
140
141 void
142 Action::ValueNodeDynamicListRemove::undo()
143 {
144         value_node->add(list_entry,index);
145
146         // Signal that a layer has been inserted
147         value_node->changed();
148 /*_if(get_canvas_interface())
149         {
150                 get_canvas_interface()->signal_value_node_changed()(value_node);
151         }
152         else synfig::warning("CanvasInterface not set on action");*/
153 }