synfig-studio/trunk/src/synfigapp/actions/layersetdesc.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file layersetdesc.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 "layersetdesc.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::LayerSetDesc);
  48 ACTION_SET_NAME(Action::LayerSetDesc,"layer_set_desc");
  49 ACTION_SET_LOCAL_NAME(Action::LayerSetDesc,N_("Set Layer Description"));
  50 ACTION_SET_TASK(Action::LayerSetDesc,"set_desc");
  51 ACTION_SET_CATEGORY(Action::LayerSetDesc,Action::CATEGORY_LAYER);
  52 ACTION_SET_PRIORITY(Action::LayerSetDesc,0);
  53 ACTION_SET_VERSION(Action::LayerSetDesc,"0.0");
  54 ACTION_SET_CVS_ID(Action::LayerSetDesc,"$Id$");
  55
  56 /* === G L O B A L S ======================================================= */
  57
  58 static const int nindex=-1;
  59
  60 /* === P R O C E D U R E S ================================================= */
  61
  62 /* === M E T H O D S ======================================================= */
  63
  64 Action::LayerSetDesc::LayerSetDesc()
  65 {
  66 }
  67
  68 synfig::String
  69 Action::LayerSetDesc::get_local_name()const
  70 {
  71         return strprintf("%s: '%s' -> '%s'",
  72                                          _("Set Layer Description"),
  73                                          /* TRANSLATORS: this is the string used in the history dialog when renaming a layer to/from its default name */
  74                                          old_description.empty() ? _("[default]") : old_description.c_str(),
  75                                          new_description.empty() ? _("[default]") : new_description.c_str());
  76 }
  77
  78 Action::ParamVocab
  79 Action::LayerSetDesc::get_param_vocab()
  80 {
  81         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  82
  83         ret.push_back(ParamDesc("layer",Param::TYPE_LAYER)
  84                 .set_local_name(_("Layer"))
  85                 .set_desc(_("Layer to be moved"))
  86         );
  87
  88         ret.push_back(ParamDesc("new_description",Param::TYPE_STRING)
  89                 .set_local_name(_("New Description"))
  90                 .set_local_name(_("Enter a new description for this layer"))
  91                 .set_user_supplied()
  92         );
  93
  94         return ret;
  95 }
  96
  97 bool
  98 Action::LayerSetDesc::is_candidate(const ParamList &x)
  99 {
 100         return candidate_check(get_param_vocab(),x);
 101 }
 102
 103 bool
 104 Action::LayerSetDesc::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_description" && param.get_type()==Param::TYPE_STRING)
 114         {
 115                 new_description=param.get_string();
 116
 117                 return true;
 118         }
 119
 120         return Action::CanvasSpecific::set_param(name,param);
 121 }
 122
 123 bool
 124 Action::LayerSetDesc::is_ready()const
 125 {
 126         if(!layer)
 127                 return false;
 128         return Action::CanvasSpecific::is_ready();
 129 }
 130
 131 void
 132 Action::LayerSetDesc::perform()
 133 {
 134         old_description=layer->get_description();
 135         layer->set_description(new_description);
 136         set_dirty(false);
 137         if(get_canvas_interface())
 138         {
 139                 get_canvas_interface()->signal_layer_new_description()(layer,new_description);
 140         }
 141         else synfig::warning("CanvasInterface not set on action");
 142 }
 143
 144 void
 145 Action::LayerSetDesc::undo()
 146 {
 147         layer->set_description(old_description);
 148         set_dirty(false);
 149         if(get_canvas_interface())
 150         {
 151                 get_canvas_interface()->signal_layer_new_description()(layer,old_description);
 152         }
 153         else synfig::warning("CanvasInterface not set on action");
 154 }