Logo ROOT   6.08/07
Reference Guide
Go to the documentation of this file.
1 // @(#)root/base:$Id$
2 // Author: Valeriy Onuchin 04/27/2004
4 /*************************************************************************
5  * Copyright (C) 1995-2000, Rene Brun and Fons Rademakers. *
6  * All rights reserved. *
7  * *
8  * For the licensing terms see $ROOTSYS/LICENSE. *
9  * For the list of contributors see $ROOTSYS/README/CREDITS. *
10  *************************************************************************/
12 #ifndef ROOT_TQCommand
13 #define ROOT_TQCommand
15 //////////////////////////////////////////////////////////////////////////
16 // //
17 // TQCommand, TQUndoManager - support for multiple Undo/Redo operations //
18 // //
19 //////////////////////////////////////////////////////////////////////////
21 #ifndef ROOT_TList
22 #include "TList.h"
23 #endif
25 #ifndef ROOT_TQObject
26 #include "TQObject.h"
27 #endif
29 class TQCommand : public TList, public TQObject {
31 friend class TQUndoManager;
33 protected:
34  TQConnection *fRedo; // do/redo action
35  TQConnection *fUndo; // undo action
36  Long_t *fRedoArgs; // redo values
37  Long_t *fUndoArgs; // undo values
38  Int_t fNRargs; // number of redo arguments
39  Int_t fNUargs; // number of undo arguments
40  Int_t fState; // -1 undoing on, 1 redoing on, 0 nothing in progress
41  Int_t fStatus; // fStatus++ after Redo(), fStatus-- after Undo()
42  Bool_t fNewDelete; // kTRUE if Redo/Undo methods are new/delete
43  TString fName; // command name. Default is "ClassName::RedoName(args)"
44  TString fTitle; // command description
45  void *fObject; // object to which undo/redo actions applied
47  virtual void Init(const char *cl, void *object,
48  const char *redo, const char *undo);
49  virtual void PrintCollectionHeader(Option_t* option) const;
51 private:
52  TQCommand &operator=(const TQCommand &); // Not yet implemented.
54 public:
55  TQCommand(const char *cl = 0, void *object = 0,
56  const char *redo = 0, const char *undo = 0);
57  TQCommand(TObject *obj, const char *redo = 0, const char *undo = 0);
58  TQCommand(const TQCommand &com);
59  virtual ~TQCommand();
61  virtual void Redo(Option_t *option=""); //*SIGNAL*
62  virtual void Undo(Option_t *option=""); //*SIGNAL*
63  virtual void SetArgs(Int_t nargs, ...);
64  virtual void SetUndoArgs(Int_t nargs, ...);
65  virtual void SetRedoArgs(Int_t nargs, ...);
66  virtual Bool_t CanMerge(TQCommand *c) const;
67  virtual void Merge(TQCommand *c);
69  virtual Bool_t CanCompress(TQCommand *c) const;
70  virtual void Compress(TQCommand *c);
71  virtual Bool_t IsEqual(const TObject* obj) const;
72  virtual Bool_t IsSetter() const;
73  virtual Bool_t CanRedo() const;
74  virtual Bool_t CanUndo() const;
75  const char *GetRedoName() const;
76  const char *GetUndoName() const;
77  TQConnection *GetRedo() const { return fRedo; }
78  TQConnection *GetUndo() const { return fUndo; }
79  Long_t *GetRedoArgs() const;
80  Long_t *GetUndoArgs() const;
81  Int_t GetNRargs() const;
82  Int_t GetNUargs() const;
83  void *GetObject() const;
84  Int_t GetStatus() const;
85  Bool_t IsMacro() const;
86  Bool_t IsUndoing() const;
87  Bool_t IsRedoing() const;
88  Bool_t IsExecuting() const;
89  virtual void SetName(const char *name);
90  virtual void SetTitle(const char *title);
91  virtual void ls(Option_t *option="") const;
92  virtual void Add(TObject *obj, Option_t *opt);
93  virtual void Add(TObject *obj) { Add(obj, 0); }
94  virtual void Delete(Option_t *option="");
95  virtual const char *GetName() const;
96  virtual const char *GetTitle() const;
98  static TQCommand *GetCommand();
100  ClassDef(TQCommand,0) // encapsulates the information for undo/redo a single action.
101 };
104 //////////////////////////////////////////////////////////////////////////
105 class TQUndoManager : public TQCommand {
107 protected:
108  TObjLink *fCursor; // current position in history stack
109  TQCommand *fCurrent; // the latest executed command
110  UInt_t fLimit; // maximum number of commands can be located in stack
111  TList *fLogBook; // listing of all actions during execution
112  Bool_t fLogging; // kTRUE if logging is ON
114  virtual void PrintCollectionEntry(TObject* entry, Option_t* option, Int_t recurse) const;
116 public:
117  TQUndoManager();
118  virtual ~TQUndoManager();
120  virtual void Add(TObject *obj, Option_t *opt);
121  virtual void Add(TObject *obj) { Add(obj, 0); }
122  virtual void Redo(Option_t *option="");
123  virtual void Undo(Option_t *option="");
124  virtual Bool_t CanRedo() const;
125  virtual Bool_t CanUndo() const;
126  virtual void SetLogging(Bool_t on = kTRUE);
127  Bool_t IsLogging() const;
128  TQCommand *GetCurrent() const;
129  TQCommand *GetCursor() const;
130  UInt_t GetLimit() const;
131  virtual void SetLimit(UInt_t limit);
132  virtual void CurrentChanged(TQCommand *c); //*SIGNAL*
133  virtual void ls(Option_t *option="") const;
135  ClassDef(TQUndoManager,0) // recorder of operations for undo and redo
136 };
138 #endif
virtual void Add(TObject *obj)
Definition: TQCommand.h:121
virtual void Add(TObject *obj)
Definition: TQCommand.h:93
virtual void SetUndoArgs(Int_t nargs,...)
Set undo parameters.
Definition: TQCommand.cxx:539
virtual void Merge(TQCommand *c)
Add command to the list of merged commands.
Definition: TQCommand.cxx:326
TString fName
Definition: TQCommand.h:43
Int_t fNRargs
Definition: TQCommand.h:38
long long Long64_t
Definition: RtypesCore.h:69
Int_t fNUargs
Definition: TQCommand.h:39
Int_t fState
Definition: TQCommand.h:40
Long_t * GetUndoArgs() const
Returns a pointer to array of undo arguments.
Definition: TQCommand.cxx:745
Bool_t IsUndoing() const
Undo action is in progress.
Definition: TQCommand.cxx:793
return c
TQConnection * fUndo
Definition: TQCommand.h:35
const char Option_t
Definition: RtypesCore.h:62
TQCommand * fCurrent
Definition: TQCommand.h:109
Bool_t IsRedoing() const
Redo action is in progress.
Definition: TQCommand.cxx:801
const char * GetUndoName() const
Returns the name of undo command.
Definition: TQCommand.cxx:729
Long_t * fUndoArgs
Definition: TQCommand.h:37
virtual void Compress(TQCommand *c)
Compress command.
Definition: TQCommand.cxx:399
TList * fLogBook
Definition: TQCommand.h:111
This is the ROOT implementation of the Qt object communication mechanism (see also http://www...
Definition: TQObject.h:53
Long_t * GetRedoArgs() const
Returns a pointer to array of redo arguments.
Definition: TQCommand.cxx:737
virtual Bool_t CanMerge(TQCommand *c) const
Two commands can be merged if they can be composed into a single command (Macro command).
Definition: TQCommand.cxx:311
virtual void Init(const char *cl, void *object, const char *redo, const char *undo)
Common protected method used in several constructors.
Definition: TQCommand.cxx:119
Long_t * fRedoArgs
Definition: TQCommand.h:36
TQConnection * GetRedo() const
Definition: TQCommand.h:77
Basic string class.
Definition: TString.h:137
virtual Bool_t IsEqual(const TObject *obj) const
Equal comparison.
Definition: TQCommand.cxx:415
int Int_t
Definition: RtypesCore.h:41
bool Bool_t
Definition: RtypesCore.h:59
virtual Bool_t IsSetter() const
Returns kTRUE is command if Redo is the same as Undo function and is the setter action.
Definition: TQCommand.cxx:437
virtual Bool_t CanRedo() const
Returns kTRUE if Redo action is possible, kFALSE if it's not.
Definition: TQCommand.cxx:568
virtual ~TQCommand()
Definition: TQCommand.cxx:248
virtual void Redo(Option_t *option="")
Execute command and then merge commands.
Definition: TQCommand.cxx:585
TQConnection * GetUndo() const
Definition: TQCommand.h:78
Int_t GetNRargs() const
Returns a number of redo arguments.
Definition: TQCommand.cxx:753
Int_t GetNUargs() const
Returns a number of undo arguments.
Definition: TQCommand.cxx:761
virtual void SetArgs(Int_t nargs,...)
Set do/redo and undo parameters.
Definition: TQCommand.cxx:462
#define ClassDef(name, id)
Definition: Rtypes.h:254
TString fTitle
Definition: TQCommand.h:44
virtual void PrintCollectionEntry(TObject *entry, Option_t *option, Int_t recurse) const
Print the collection entry.
Bool_t fNewDelete
Definition: TQCommand.h:42
TQCommand(const char *cl=0, void *object=0, const char *redo=0, const char *undo=0)
Definition: TQCommand.cxx:167
TQConnection * fRedo
Definition: TQCommand.h:34
Bool_t IsExecuting() const
Returns kTRUE if command execution is in progress.
Definition: TQCommand.cxx:809
UInt_t fLimit
Definition: TQCommand.h:110
A doubly linked list.
Definition: TList.h:47
void * GetObject() const
Returns an object for which undo redo actions are applied.
Definition: TQCommand.cxx:769
TQConnection class is an internal class, used in the object communication mechanism.
Definition: TQConnection.h:46
Collection abstract base class.
Definition: TCollection.h:48
TQCommand & operator=(const TQCommand &)
unsigned int UInt_t
Definition: RtypesCore.h:42
virtual Bool_t CanCompress(TQCommand *c) const
By default, commands can be compressed if they are:
Definition: TQCommand.cxx:384
virtual void Delete(Option_t *option="")
If "opt" is not zero delete every merged command which option string is equal to "opt".
Definition: TQCommand.cxx:284
Int_t GetStatus() const
Returns a number of sequential undo or redo operations.
Definition: TQCommand.cxx:777
virtual Bool_t CanUndo() const
Returns kTRUE if Undo action is possible, kFALSE if it's not.
Definition: TQCommand.cxx:577
Bool_t fLogging
Definition: TQCommand.h:112
friend class TQUndoManager
Definition: TQCommand.h:31
virtual void SetTitle(const char *title)
Sets description of the command.
Definition: TQCommand.cxx:825
virtual void ls(Option_t *option="") const
ls this command and merged commands
Definition: TQCommand.cxx:833
long Long_t
Definition: RtypesCore.h:50
Bool_t IsMacro() const
Returns kTRUE if neither redo nor undo action specified.
Definition: TQCommand.cxx:785
virtual void SetName(const char *name)
Sets name of the command.
Definition: TQCommand.cxx:817
virtual void Add(TObject *obj, Option_t *opt)
Add command to the list of merged commands.
Definition: TQCommand.cxx:357
virtual const char * GetTitle() const
Returns command description.
Definition: TQCommand.cxx:703
virtual void SetRedoArgs(Int_t nargs,...)
Set redo parameters.
Definition: TQCommand.cxx:505
virtual void Undo(Option_t *option="")
Un-execute all merged commands and the command.
Definition: TQCommand.cxx:623
Mother of all ROOT objects.
Definition: TObject.h:37
Recorder of operations for undo and redo.
Definition: TQCommand.h:105
static TQCommand * GetCommand()
Return a command which is doing redo/undo action.
Definition: TQCommand.cxx:275
void * fObject
Definition: TQCommand.h:45
virtual const char * GetName() const
Returns the command name.
Definition: TQCommand.cxx:667
The Command design pattern is based on the idea, that all editing in an application is done by creati...
Definition: TQCommand.h:29
const char * GetRedoName() const
Returns the name of redo command.
Definition: TQCommand.cxx:721
const Bool_t kTRUE
Definition: Rtypes.h:91
TObjLink * fCursor
Definition: TQCommand.h:108
virtual void PrintCollectionHeader(Option_t *option) const
Print collection header.
Definition: TQCommand.cxx:849
Int_t fStatus
Definition: TQCommand.h:41
char name[80]
Definition: TGX11.cxx:109