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

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file canvasadd.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 "canvasadd.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(Action::CanvasAdd);
  48 ACTION_SET_NAME(Action::CanvasAdd,"CanvasAdd");
  49 ACTION_SET_LOCAL_NAME(Action::CanvasAdd,N_("Add Child Canvas"));
  50 ACTION_SET_TASK(Action::CanvasAdd,"add");
  51 ACTION_SET_CATEGORY(Action::CanvasAdd,Action::CATEGORY_CANVAS);
  52 ACTION_SET_PRIORITY(Action::CanvasAdd,0);
  53 ACTION_SET_VERSION(Action::CanvasAdd,"0.0");
  54 ACTION_SET_CVS_ID(Action::CanvasAdd,"$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::CanvasAdd::CanvasAdd()
  63 {
  64         set_dirty(true);
  65 }
  66
  67 Action::ParamVocab
  68 Action::CanvasAdd::get_param_vocab()
  69 {
  70         ParamVocab ret(Action::CanvasSpecific::get_param_vocab());
  71
  72         ret.push_back(ParamDesc("src",Param::TYPE_CANVAS)
  73                 .set_local_name(_("New Canvas"))
  74                 .set_optional()
  75         );
  76
  77         ret.push_back(ParamDesc("id",Param::TYPE_STRING)
  78                 .set_local_name(_("ID"))
  79                 .set_desc(_("The name that you want this canvas to be"))
  80                 .set_user_supplied()
  81         );
  82
  83         return ret;
  84 }
  85
  86 bool
  87 Action::CanvasAdd::is_candidate(const ParamList &x)
  88 {
  89         return candidate_check(get_param_vocab(),x);
  90 }
  91
  92 bool
  93 Action::CanvasAdd::set_param(const synfig::String& name, const Action::Param &param)
  94 {
  95         if(name=="src" && param.get_type()==Param::TYPE_CANVAS)
  96         {
  97                 new_canvas=param.get_canvas();
  98
  99                 return true;
 100         }
 101         if(name=="id" && param.get_type()==Param::TYPE_STRING)
 102         {
 103                 id=param.get_string();
 104
 105                 return true;
 106         }
 107
 108         return Action::CanvasSpecific::set_param(name,param);
 109 }
 110
 111 bool
 112 Action::CanvasAdd::is_ready()const
 113 {
 114         return Action::CanvasSpecific::is_ready();
 115 }
 116
 117 void
 118 Action::CanvasAdd::perform()
 119 {
 120         if(!new_canvas)
 121         {
 122                 new_canvas=get_canvas()->new_child_canvas(id);
 123         }
 124         else
 125         {
 126                 if(new_canvas->is_inline())
 127                 {
 128                         inline_parent=new_canvas->parent();
 129                 }
 130                 get_canvas()->add_child_canvas(new_canvas,id);
 131         }
 132
 133         if(get_canvas_interface())
 134         {
 135                 get_canvas_interface()->signal_canvas_added()(new_canvas);
 136         }
 137         else synfig::warning("CanvasInterface not set on action");
 138 }
 139
 140 void
 141 Action::CanvasAdd::undo()
 142 {
 143         get_canvas()->remove_child_canvas(new_canvas);
 144
 145         if(inline_parent)
 146                 new_canvas->set_inline(inline_parent);
 147
 148         if(get_canvas_interface())
 149         {
 150                 get_canvas_interface()->signal_canvas_removed()(new_canvas);
 151         }
 152         else synfig::warning("CanvasInterface not set on action");
 153 }