synfig-studio/src/synfigapp/actions/layeractivate.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file layeractivate.cpp
   3 **      \brief Template File
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2008 Chris Moore
  10 **
  11 **      This package is free software; you can redistribute it and/or
  12 **      modify it under the terms of the GNU General Public License as
  13 **      published by the Free Software Foundation; either version 2 of
  14 **      the License, or (at your option) any later version.
  15 **
  16 **      This package is distributed in the hope that it will be useful,
  17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 **      General Public License for more details.
  20 **      \endlegal
  21 */
  22 /* ========================================================================= */
  23
  24 /* === H E A D E R S ======================================================= */
  25
  26 #ifdef USING_PCH
  27 #       include "pch.h"
  28 #else
  29 #ifdef HAVE_CONFIG_H
  30 #       include <config.h>
  31 #endif
  32
  33 #include "layeractivate.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_NO_GET_LOCAL_NAME(Action::LayerActivate);
  49 ACTION_SET_NAME(Action::LayerActivate,"LayerActivate");
  50 ACTION_SET_LOCAL_NAME(Action::LayerActivate,N_("Activate Layer"));
  51 ACTION_SET_TASK(Action::LayerActivate,"activate");
  52 ACTION_SET_CATEGORY(Action::LayerActivate,Action::CATEGORY_LAYER);
  53 ACTION_SET_PRIORITY(Action::LayerActivate,0);
  54 ACTION_SET_VERSION(Action::LayerActivate,"0.0");
  55 ACTION_SET_CVS_ID(Action::LayerActivate,"$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::LayerActivate::LayerActivate()
  64 {
  65 }
  66
  67 synfig::String
  68 Action::LayerActivate::get_local_name()const
  69 {
  70         if(!layer)
  71                 return _("Activate Layer");
  72
  73         return strprintf("%s '%s'",
  74                                          new_status
  75                                          ? _("Activate Layer")
  76                                          : _("Deactivate Layer"),
  77                                          layer->get_non_empty_description().c_str());
  78 }
  79
  80 Action::ParamVocab
  81 Action::LayerActivate::get_param_vocab()
  82 {
  83         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  84
  85         ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
  86                 .set_local_name(_("Layer"))
  87         );
  88
  89         ret.push_back(ParamDesc("new_status",Param::TYPE_BOOL)
  90                 .set_local_name(_("New Status"))
  91                 .set_desc(_("The new status of the layer"))
  92         );
  93
  94         return ret;
  95 }
  96
  97 bool
  98 Action::LayerActivate::is_candidate(const ParamList &x)
  99 {
 100         return candidate_check(get_param_vocab(),x);
 101 }
 102
 103 bool
 104 Action::LayerActivate::set_param(const synfig::String& name, const Action::Param &param)
 105 {
 106         if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
 107         {
 108                 layer=param.get_layer();
 109
 110                 return true;
 111         }
 112
 113         if(name=="new_status" && param.get_type()==Param::TYPE_BOOL)
 114         {
 115                 new_status=param.get_bool();
 116
 117                 return true;
 118         }
 119
 120         return Action::CanvasSpecific::set_param(name,param);
 121 }
 122
 123 bool
 124 Action::LayerActivate::is_ready()const
 125 {
 126         if(!layer)
 127                 return false;
 128         return Action::CanvasSpecific::is_ready();
 129 }
 130
 131 void
 132 Action::LayerActivate::perform()
 133 {
 134         Canvas::Handle subcanvas(layer->get_canvas());
 135
 136         // Find the iterator for the layer
 137         Canvas::iterator iter=find(subcanvas->begin(),subcanvas->end(),layer);
 138
 139         // If we couldn't find the layer in the canvas, then bail
 140         if(*iter!=layer)
 141                 throw Error(_("This layer doesn't exist anymore."));
 142
 143         // If the subcanvas isn't the same as the canvas,
 144         // then it had better be an inline canvas. If not,
 145         // bail
 146         //if(get_canvas()!=subcanvas && !subcanvas->is_inline())
 147         //if(get_canvas()->get_root()!=subcanvas->get_root())
 148         //      throw Error(_("This layer doesn't belong to this composition"));
 149
 150         old_status=layer->active();
 151
 152         // If we are changing the status to what it already is,
 153         // the go ahead and return
 154         if(new_status==old_status)
 155         {
 156                 set_dirty(false);
 157                 return;
 158         }
 159         else
 160                 set_dirty();
 161
 162         if(new_status)
 163                 layer->enable();
 164         else
 165                 layer->disable();
 166
 167         if(get_canvas_interface())
 168         {
 169                 get_canvas_interface()->signal_layer_status_changed()(layer,new_status);
 170         }
 171         else synfig::warning("CanvasInterface not set on action");
 172 }
 173
 174 void
 175 Action::LayerActivate::undo()
 176 {
 177         // If we are changing the status to what it already is,
 178         // the go ahead and return
 179         if(new_status==old_status)
 180         {
 181                 set_dirty(false);
 182                 return;
 183         }
 184         else
 185                 set_dirty();
 186
 187         // restore the old status
 188         if(old_status)
 189                 layer->enable();
 190         else
 191                 layer->disable();
 192
 193         if(get_canvas_interface())
 194         {
 195                 get_canvas_interface()->signal_layer_status_changed()(layer,old_status);
 196         }
 197         else synfig::warning("CanvasInterface not set on action");
 198 }