home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / include / k3d / k3dsdk / istate_recorder.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-11-07  |  4.6 KB  |  107 lines
  1. #ifndef K3DSDK_ISTATE_RECORDER_H
  2. #define K3DSDK_ISTATE_RECORDER_H
  3.  
  4. // K-3D
  5. // Copyright (c) 1995-2005, Timothy M. Shead
  6. //
  7. // Contact: tshead@k-3d.com
  8. //
  9. // This program is free software; you can redistribute it and/or
  10. // modify it under the terms of the GNU General Public
  11. // License as published by the Free Software Foundation; either
  12. // version 2 of the License, or (at your option) any later version.
  13. //
  14. // This program is distributed in the hope that it will be useful,
  15. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17. // General Public License for more details.
  18. //
  19. // You should have received a copy of the GNU General Public
  20. // License along with this program; if not, write to the Free Software
  21. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22.  
  23. /** \file
  24.     \author Tim Shead (tshead@k-3d.com)
  25. */
  26.  
  27. #include "iunknown.h"
  28. #include "signal_system.h"
  29.  
  30. #include <memory>
  31. #include <string>
  32. #include <vector>
  33.  
  34. namespace k3d
  35. {
  36.  
  37. class state_change_set;
  38.     
  39. /// Abstract interface for an object that can store a hierarchical tree of state changes to the document
  40. class istate_recorder :
  41.     public virtual iunknown
  42. {
  43. public:
  44.     /// Called by clients to register a change set for recording subsequent state changes (the recorder assumes responsibility for the lifetime of the changeset)
  45.     virtual void start_recording(std::auto_ptr<state_change_set> ChangeSet, const char* const DebugLabel) = 0;
  46.     /// Returns the current change set being recorded (if any - could return NULL)
  47.     virtual state_change_set* current_change_set() = 0;
  48.     /// Called by clients to stop recording a set of state changes (the recorder relinquishes responsibility for the lifetime of the returned changeset)
  49.     virtual std::auto_ptr<state_change_set> stop_recording(const char* const DebugLabel) = 0;
  50.     /// Called by clients once a set of changes is complete, to make them a part of the undo/redo tree (the recorder assumes responsibility for the lifetime of the change set)
  51.     virtual void commit_change_set(std::auto_ptr<state_change_set> ChangeSet, const std::string& Label, const char* const DebugLabel) = 0;
  52.  
  53.     /// Defines a collection of "nodes" in the hierarchy of recorded state changes
  54.     struct node;
  55.     typedef std::vector<node*> nodes_t;
  56.  
  57.     /// Encapsulates a single "node" in the hierarchy of recorded state changes
  58.     struct node
  59.     {
  60.         node(const std::string& Label, state_change_set* const ChangeSet, node* const Parent) : label(Label), change_set(ChangeSet), parent(Parent) { }
  61.  
  62.         /// Stores the human-readable label for this node
  63.         const std::string label;
  64.         /// Points to the change set owned by this node
  65.         state_change_set* const change_set;
  66.         /// Points to this node's parent (NULL for the root node)
  67.         node* const parent;
  68.         /// Points to this node's children
  69.         nodes_t children;
  70.     };
  71.  
  72.     /// Returns the root node(s) in the hierarchy of recorded state changes (could return an empty collection if no recording has taken place)
  73.     virtual const nodes_t& root_nodes() = 0;
  74.     /// Returns the current node - the node that will become the parent of any subsequently recorded nodes (could return NULL)
  75.     virtual const node* current_node() = 0;
  76.     /// Returns the newest (most-recently-created) node, which is typically the node that should be the "goal" of redo operations (could return NULL if nothing's been recorded yet)
  77.     virtual const node* newest_node() = 0;
  78.     /// Returns the most-recently-saved node in the hierarchy of recorded state changes (could return NULL if no save has taken place)
  79.     virtual const node* last_saved_node() = 0;
  80.  
  81.     /// Called to set the current node
  82.     virtual void set_current_node(const node* const Node) = 0;
  83.     /// Called to mark the current node as saved
  84.     virtual void mark_saved() = 0;
  85.  
  86.     /// Connects a slot that will be called when recording finishes
  87.     virtual sigc::connection connect_recording_done_signal(const sigc::slot<void>& Slot) = 0;
  88.     
  89.     /// Connects a slot that will be called after a node is added to the hierarchy
  90.     virtual sigc::connection connect_node_added_signal(const sigc::slot<void, const node*>& Slot) = 0;
  91.     /// Connects a slot that will be called when the current node has changed
  92.     virtual sigc::connection connect_current_node_changed_signal(const sigc::slot<void>& Slot) = 0;
  93.     /// Connects a slot that will be called when the last saved node has changed
  94.     virtual sigc::connection connect_last_saved_node_changed_signal(const sigc::slot<void>& Slot) = 0;
  95.  
  96. protected:
  97.     istate_recorder() {}
  98.     istate_recorder(const istate_recorder& RHS) {}
  99.     istate_recorder& operator = (const istate_recorder& RHS) { return *this; }
  100.     virtual ~istate_recorder() {}
  101. };
  102.  
  103. } // namespace k3d
  104.  
  105. #endif // !K3DSDK_ISTATE_RECORDER_H
  106.  
  107.