synfig-studio/trunk/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 **
  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 "layeractivate.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::LayerActivate);
  48 ACTION_SET_NAME(Action::LayerActivate,"layer_activate");
  49 ACTION_SET_LOCAL_NAME(Action::LayerActivate,N_("Activate Layer"));
  50 ACTION_SET_TASK(Action::LayerActivate,"activate");
  51 ACTION_SET_CATEGORY(Action::LayerActivate,Action::CATEGORY_LAYER);
  52 ACTION_SET_PRIORITY(Action::LayerActivate,0);
  53 ACTION_SET_VERSION(Action::LayerActivate,"0.0");
  54 ACTION_SET_CVS_ID(Action::LayerActivate,"$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::LayerActivate::LayerActivate()
  63 {
  64 }
  65
  66 synfig::String
  67 Action::LayerActivate::get_local_name()const
  68 {
  69         if(!layer)
  70                 return _("Activate Layer");
  71
  72         return strprintf("%s '%s'",
  73                                          new_status
  74                                          ? _("Activate Layer")
  75                                          : _("Deactivate Layer"),
  76                                          layer->get_non_empty_description().c_str());
  77 }
  78
  79 Action::ParamVocab
  80 Action::LayerActivate::get_param_vocab()
  81 {
  82         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  83
  84         ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
  85                 .set_local_name(_("Layer"))
  86         );
  87
  88         ret.push_back(ParamDesc("new_status",Param::TYPE_BOOL)
  89                 .set_local_name(_("New Status"))
  90                 .set_desc(_("The new status of the layer"))
  91         );
  92
  93         return ret;
  94 }
  95
  96 bool
  97 Action::LayerActivate::is_candidate(const ParamList &x)
  98 {
  99         return candidate_check(get_param_vocab(),x);
 100 }
 101
 102 bool
 103 Action::LayerActivate::set_param(const synfig::String& name, const Action::Param &param)
 104 {
 105         if(name=="layer" && param.get_type()==Param::TYPE_LAYER)
 106         {
 107                 layer=param.get_layer();
 108
 109                 return true;
 110         }
 111
 112         if(name=="new_status" && param.get_type()==Param::TYPE_BOOL)
 113         {
 114                 new_status=param.get_bool();
 115
 116                 return true;
 117         }
 118
 119         return Action::CanvasSpecific::set_param(name,param);
 120 }
 121
 122 bool
 123 Action::LayerActivate::is_ready()const
 124 {
 125         if(!layer)
 126                 return false;
 127         return Action::CanvasSpecific::is_ready();
 128 }
 129
 130 void
 131 Action::LayerActivate::perform()
 132 {
 133         Canvas::Handle subcanvas(layer->get_canvas());
 134
 135         // Find the iterator for the layer
 136         Canvas::iterator iter=find(subcanvas->begin(),subcanvas->end(),layer);
 137
 138         // If we couldn't find the layer in the canvas, then bail
 139         if(*iter!=layer)
 140                 throw Error(_("This layer doesn't exist anymore."));
 141
 142         // If the subcanvas isn't the same as the canvas,
 143         // then it had better be an inline canvas. If not,
 144         // bail
 145         //if(get_canvas()!=subcanvas && !subcanvas->is_inline())
 146         //if(get_canvas()->get_root()!=subcanvas->get_root())
 147         //      throw Error(_("This layer doesn't belong to this composition"));
 148
 149         old_status=layer->active();
 150
 151         // If we are changing the status to what it already is,
 152         // the go ahead and return
 153         if(new_status==old_status)
 154         {
 155                 set_dirty(false);
 156                 return;
 157         }
 158         else
 159                 set_dirty();
 160
 161         if(new_status)
 162                 layer->enable();
 163         else
 164                 layer->disable();
 165
 166         if(get_canvas_interface())
 167         {
 168                 get_canvas_interface()->signal_layer_status_changed()(layer,new_status);
 169         }
 170         else synfig::warning("CanvasInterface not set on action");
 171 }
 172
 173 void
 174 Action::LayerActivate::undo()
 175 {
 176         // If we are changing the status to what it already is,
 177         // the go ahead and return
 178         if(new_status==old_status)
 179         {
 180                 set_dirty(false);
 181                 return;
 182         }
 183         else
 184                 set_dirty();
 185
 186         // restore the old status
 187         if(old_status)
 188                 layer->enable();
 189         else
 190                 layer->disable();
 191
 192         if(get_canvas_interface())
 193         {
 194                 get_canvas_interface()->signal_layer_status_changed()(layer,old_status);
 195         }
 196         else synfig::warning("CanvasInterface not set on action");
 197 }