history_owner.h

Go to the documentation of this file.

#pragma once
 
#include <string>
#include <vector>
#include <list>
 
#include <glib.h>
 
#include "pbd/undo.h"
#include "pbd/libpbd_visibility.h"
 
namespace PBD {
        class Command;
 
 
class LIBPBD_API HistoryOwner
{
  public:
        HistoryOwner (std::string const & name);
        virtual ~HistoryOwner();
 
        void begin_reversible_command (const std::string& cmd_name);
        void begin_reversible_command (GQuark);
        void abort_reversible_command ();
        void commit_reversible_command (PBD::Command* cmd = 0);
 
        void add_command (PBD::Command *const cmd);
 
        PBD::StatefulDiffCommand* add_stateful_diff_command (std::shared_ptr<PBD::StatefulDestructible> sfd);
 
        std::list<GQuark> const & current_operations () {
                return _current_trans_quarks;
        }
 
        bool operation_in_progress (GQuark) const;
 
        bool collected_undo_commands () const {
                return _current_trans && !_current_trans->empty ();
        }
 
        PBD::UndoTransaction* current_reversible_command() { return _current_trans; }
 
        bool abort_empty_reversible_command ();
 
        void add_commands (std::vector<PBD::Command*> const & cmds);
 
        PBD::UndoHistory& undo_redo() { return _history; }
 
  protected:
        std::string           _name;
        PBD::UndoHistory      _history;
        PBD::UndoTransaction* _current_trans;
        std::list<GQuark>     _current_trans_quarks;
};
 
} /* namespace PBD */