synfig-studio/src/synfigapp/actions/canvasdescriptionset.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file canvasdescriptionset.h
   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 /* === S T A R T =========================================================== */
  25
  26 #ifndef __SYNFIG_APP_ACTION_CANVASDESCRIPTIONSET_H
  27 #define __SYNFIG_APP_ACTION_CANVASDESCRIPTIONSET_H
  28
  29 /* === H E A D E R S ======================================================= */
  30
  31 #include <synfigapp/action.h>
  32
  33 /* === M A C R O S ========================================================= */
  34
  35 /* === T Y P E D E F S ===================================================== */
  36
  37 /* === C L A S S E S & S T R U C T S ======================================= */
  38
  39 namespace synfigapp {
  40
  41 class Instance;
  42
  43 namespace Action {
  44
  45 class CanvasDescriptionSet :
  46         public Undoable,
  47         public CanvasSpecific
  48 {
  49 private:
  50
  51         synfig::String new_description;
  52         synfig::String old_description;
  53
  54 public:
  55
  56         CanvasDescriptionSet();
  57
  58         static ParamVocab get_param_vocab();
  59         static bool is_candidate(const ParamList &x);
  60
  61         virtual bool set_param(const synfig::String& description, const Param &);
  62         virtual bool is_ready()const;
  63
  64         virtual void perform();
  65         virtual void undo();
  66
  67         ACTION_MODULE_EXT
  68 };
  69
  70 }; // END of namespace action
  71 }; // END of namespace studio
  72
  73 /* === E N D =============================================================== */
  74
  75 #endif