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         String ret;
  70
  71         if (layer_list.empty())
  72                 return _("Remove Layer");
  73
  74         ret = strprintf("%s '%s'",
  75                                         (layer_list.size() == 1
  76                                          ? _("Remove Layer")
  77                                          : _("Remove Layers")),
  78                                         layer_list.begin()->first->get_non_empty_description().c_str());
  79
  80         for(std::list<std::pair<synfig::Layer::Handle,int> >::const_iterator iter=++layer_list.begin(); iter!=layer_list.end(); ++iter)
  81                 ret += strprintf(", '%s'", (iter->first->get_non_empty_description().c_str()));
  82         return ret;
  83 }
  84
  85 Action::ParamVocab
  86 Action::LayerRemove::get_param_vocab()
  87 {
  88         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  89
  90         ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
  91                 .set_local_name(_("Layer"))
  92                 .set_desc(_("Layer to be deleted"))
  93                 .set_supports_multiple()
  94         );
  95
  96         return ret;
  97 }
  98
  99 bool
 100 Action::LayerRemove::is_candidate(const ParamList &x)
 101 {
 102         return candidate_check(get_param_vocab(),x);
 103 }
 104
 105 bool
 106 Action::LayerRemove::set_param(const synfig::String& name, const Action::Param &param)
 107 {
 108         if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
 109         {
 110                 std::pair<synfig::Layer::Handle,int> layer_pair;
 111                 layer_pair.first=param.get_layer();
 112                 layer_list.push_back(layer_pair);
 113
 114                 return true;
 115         }
 116
 117         return Action::CanvasSpecific::set_param(name,param);
 118 }
 119
 120 bool
 121 Action::LayerRemove::is_ready()const
 122 {
 123         if(layer_list.empty())
 124                 return false;
 125         return Action::CanvasSpecific::is_ready();
 126 }
 127
 128 void
 129 Action::LayerRemove::perform()
 130 {
 131         std::list<std::pair<synfig::Layer::Handle,int> >::iterator iter;
 132         for(iter=layer_list.begin();iter!=layer_list.end();++iter)
 133         {
 134                 Layer::Handle layer(iter->first);
 135 //              int& depth(iter->second);
 136                 Canvas::Handle subcanvas(layer->get_canvas());
 137
 138                 // Find the iterator for the layer
 139                 Canvas::iterator iter2=find(subcanvas->begin(),subcanvas->end(),layer);
 140
 141                 // If we couldn't find the layer in the canvas, then bail
 142                 if(*iter2!=layer)
 143                 {
 144                         /*!     \todo We should really undo all prior removals
 145                         **      before we go throwing shit around */
 146                         throw Error(_("This layer doesn't exist anymore."));
 147                 }
 148
 149                 // If the subcanvas isn't the same as the canvas,
 150                 // then it had better be an inline canvas. If not,
 151                 // bail
 152                 if(get_canvas()!=subcanvas && !subcanvas->is_inline())
 153                 {
 154                         /*!     \todo We should really undo all prior removals
 155                         **      before we go throwing shit around */
 156                         throw Error(_("This layer doesn't belong to this canvas anymore"));
 157                 }
 158
 159                 set_canvas(subcanvas);
 160
 161                 // Calculate the depth that the layer was at (For the undo)
 162                 iter->second=layer->get_depth();
 163
 164                 // Mark ourselves as dirty if necessary
 165                 set_dirty(layer->active());
 166
 167                 // Remove the layer from the canvas
 168                 subcanvas->erase(iter2);
 169
 170                 // Signal that a layer has been removed
 171                 if(get_canvas_interface())
 172                         get_canvas_interface()->signal_layer_removed()(layer);
 173         }
 174 }
 175
 176 void
 177 Action::LayerRemove::undo()
 178 {
 179         std::list<std::pair<synfig::Layer::Handle,int> >::reverse_iterator iter;
 180         for(iter=layer_list.rbegin();iter!=layer_list.rend();++iter)
 181         {
 182                 Layer::Handle layer(iter->first);
 183                 int& depth(iter->second);
 184
 185                 // Set the layer's canvas
 186                 layer->set_canvas(get_canvas());
 187
 188                 // Make sure that the depth is valid
 189                 if(get_canvas()->size()<depth)
 190                         depth=get_canvas()->size();
 191
 192                 // Mark ourselves as dirty if necessary
 193                 set_dirty(layer->active());
 194
 195                 // Insert the layer into the canvas at the desired depth
 196                 get_canvas()->insert(get_canvas()->begin()+depth,layer);
 197
 198                 // Signal that a layer has been inserted
 199                 if(get_canvas_interface())
 200                         get_canvas_interface()->signal_layer_inserted()(layer,depth);
 201         }
 202 }