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 #include "pbd/command.h"
  21
  22 namespace PBD
  23 {
  24
  25 class Stateful;
  26
  27 /** A Command which stores its action as the differences between the before and after
  28  *  state of a Stateful object.
  29  */
  30 class StatefulDiffCommand : public Command
  31 {
  32 public:
  33         StatefulDiffCommand (Stateful *);
  34         StatefulDiffCommand (Stateful *, XMLNode const &);
  35         ~StatefulDiffCommand ();
  36
  37         void operator() ();
  38         void undo ();
  39
  40         XMLNode& get_state ();
  41
  42 private:
  43         Stateful* _object; ///< the object in question
  44         XMLNode* _before; ///< XML node containing the previous values of XML properties which changed
  45         XMLNode* _after; ///< XML node containing the new values of XML properties which changed
  46 };
  47
  48 };