libs/pbd/pbd/command.h

   1 /*
   2     Copyright (C) 2006 Paul Davis
   3     Author: Hans Fugal
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #ifndef __lib_pbd_command_h__
  22 #define __lib_pbd_command_h__
  23
  24 #include "pbd/statefuldestructible.h"
  25 #include <boost/utility.hpp>
  26
  27 class Command : public PBD::StatefulDestructible, public boost::noncopyable
  28 {
  29 public:
  30         virtual ~Command() { /* NOTE: derived classes must call drop_references() */ }
  31
  32         virtual void operator() () = 0;
  33
  34         void set_name (const std::string& str) { _name = str; }
  35         const std::string& name() const { return _name; }
  36
  37         virtual void undo() = 0;
  38         virtual void redo() { (*this)(); }
  39
  40         virtual XMLNode &get_state();
  41         virtual int set_state(const XMLNode&) { /* noop */ return 0; }
  42
  43 protected:
  44         Command() {}
  45         Command(const std::string& name) : _name(name) {}
  46
  47         std::string _name;
  48 };
  49
  50 #endif // __lib_pbd_command_h_