libs/pbd/pbd/stateful_diff_command.h

   1 /*
   2     Copyright (C) 2010 Paul Davis
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 #ifndef __pbd_stateful_diff_command_h__
  21 #define __pbd_stateful_diff_command_h__
  22
  23 #include <boost/shared_ptr.hpp>
  24 #include <boost/weak_ptr.hpp>
  25
  26 #include "pbd/libpbd_visibility.h"
  27 #include "pbd/command.h"
  28
  29 namespace PBD
  30 {
  31
  32 class StatefulDestructible;
  33 class PropertyList;
  34
  35 /** A Command which stores its action as the differences between the before and after
  36  *  state of a Stateful object.
  37  */
  38 class LIBPBD_API StatefulDiffCommand : public Command
  39 {
  40 public:
  41         StatefulDiffCommand (boost::shared_ptr<StatefulDestructible>);
  42         StatefulDiffCommand (boost::shared_ptr<StatefulDestructible>, XMLNode const &);
  43         ~StatefulDiffCommand ();
  44
  45         void operator() ();
  46         void undo ();
  47
  48         XMLNode& get_state ();
  49
  50         bool empty () const;
  51
  52 private:
  53         boost::weak_ptr<Stateful> _object; ///< the object in question
  54         PBD::PropertyList* _changes; ///< property changes to execute this command
  55 };
  56
  57 };
  58
  59 #endif /* __pbd_stateful_diff_command_h__ */