synfig-studio/tags/stable/src/synfigapp/actions/canvasdescriptionset.cpp

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file canvasdescriptionset.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 "canvasdescriptionset.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::CanvasDescriptionSet);
  49 ACTION_SET_NAME(Action::CanvasDescriptionSet,"canvas_description_set");
  50 ACTION_SET_LOCAL_NAME(Action::CanvasDescriptionSet,N_("Set Canvas Description"));
  51 ACTION_SET_TASK(Action::CanvasDescriptionSet,"set");
  52 ACTION_SET_CATEGORY(Action::CanvasDescriptionSet,Action::CATEGORY_CANVAS);
  53 ACTION_SET_PRIORITY(Action::CanvasDescriptionSet,0);
  54 ACTION_SET_VERSION(Action::CanvasDescriptionSet,"0.0");
  55 ACTION_SET_CVS_ID(Action::CanvasDescriptionSet,"$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::CanvasDescriptionSet::CanvasDescriptionSet()
  64 {
  65 }
  66
  67 synfig::String
  68 Action::CanvasDescriptionSet::get_local_name()const
  69 {
  70         // TRANSLATORS: This is used in the 'history' dialog when a Canvas has its description changed.
  71         return strprintf(_("Change canvas description from '%s' to '%s'"),
  72                                          old_description.c_str(),
  73                                          new_description.c_str());
  74 }
  75
  76 Action::ParamVocab
  77 Action::CanvasDescriptionSet::get_param_vocab()
  78 {
  79         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  80
  81         ret.push_back(ParamDesc("description",Param::TYPE_STRING)
  82                 .set_local_name(_("Description"))
  83         );
  84
  85         return ret;
  86 }
  87
  88 bool
  89 Action::CanvasDescriptionSet::is_candidate(const ParamList &x)
  90 {
  91         return candidate_check(get_param_vocab(),x);
  92 }
  93
  94 bool
  95 Action::CanvasDescriptionSet::set_param(const synfig::String& description, const Action::Param &param)
  96 {
  97         if(description=="description" && param.get_type()==Param::TYPE_STRING)
  98         {
  99                 new_description=param.get_string();
 100
 101                 return true;
 102         }
 103
 104         return Action::CanvasSpecific::set_param(description,param);
 105 }
 106
 107 bool
 108 Action::CanvasDescriptionSet::is_ready()const
 109 {
 110         if(new_description.empty())
 111         {
 112                 synfig::error("Action::CanvasDescriptionSet::is_ready(): Description not set!");
 113                 return false;
 114         }
 115
 116         return Action::CanvasSpecific::is_ready();
 117 }
 118
 119 void
 120 Action::CanvasDescriptionSet::perform()
 121 {
 122         old_description=get_canvas()->get_description();
 123
 124         get_canvas()->set_description(new_description);
 125
 126         if(get_canvas_interface())
 127                 get_canvas_interface()->signal_id_changed()();
 128         else
 129                 synfig::warning("CanvasInterface not set on action");
 130 }
 131
 132 void
 133 Action::CanvasDescriptionSet::undo()
 134 {
 135         get_canvas()->set_description(old_description);
 136
 137         if(get_canvas_interface())
 138                 get_canvas_interface()->signal_id_changed()();
 139         else
 140                 synfig::warning("CanvasInterface not set on action");
 141 }