CMS 3D CMS Logo

List of all members | Public Member Functions | Private Attributes
Vispa.Share.UndoEvent.UndoEvent Class Reference
Inheritance diagram for Vispa.Share.UndoEvent.UndoEvent:
Vispa.Share.UndoEvent.MultiUndoEvent

Public Member Functions

def __init__ (self)
 
def combine (self, otherUndoEvent)
 
def description (self)
 
def dump (self, prefix="undo")
 
def isLastSavedState (self)
 
def redo (self)
 
def setLastSavedState (self, flag)
 
def undo (self)
 

Private Attributes

 _lastSavedStateFlag
 

Detailed Description

Definition at line 3 of file UndoEvent.py.

Constructor & Destructor Documentation

def Vispa.Share.UndoEvent.UndoEvent.__init__ (   self)

Definition at line 6 of file UndoEvent.py.

6  def __init__(self):
7  pass
8 

Member Function Documentation

def Vispa.Share.UndoEvent.UndoEvent.combine (   self,
  otherUndoEvent 
)
Combines this event with another event of the same kind.

If the combination was successfull True or otherwise False will be returned.

Definition at line 19 of file UndoEvent.py.

19  def combine(self, otherUndoEvent):
20  """ Combines this event with another event of the same kind.
21 
22  If the combination was successfull True or otherwise False will be returned.
23  """
24  return False
25 
def combine(self, otherUndoEvent)
Definition: UndoEvent.py:19
def Vispa.Share.UndoEvent.UndoEvent.description (   self)
Returns a string with more detailed explanation of what this event does

E.g. what exactly was dragged, moved or which values changed.

Definition at line 26 of file UndoEvent.py.

26  def description(self):
27  """ Returns a string with more detailed explanation of what this event does
28 
29  E.g. what exactly was dragged, moved or which values changed.
30  """
31  return ""
32 
def Vispa.Share.UndoEvent.UndoEvent.dump (   self,
  prefix = "undo" 
)

Definition at line 48 of file UndoEvent.py.

References Vispa.Share.UndoEvent.UndoEvent.isLastSavedState(), Vispa.Share.UndoEvent.MultiUndoEvent.LABEL, and edm.print().

48  def dump(self, prefix="undo"):
49  print(prefix, ": ", self.LABEL, self.isLastSavedState())
50 
S & print(S &os, JobReport::InputFile const &f)
Definition: JobReport.cc:66
def dump(self, prefix="undo")
Definition: UndoEvent.py:48
def Vispa.Share.UndoEvent.UndoEvent.isLastSavedState (   self)
Returns the last saved state flag, see setLastSavedState().

Definition at line 41 of file UndoEvent.py.

References Vispa.Share.UndoEvent.UndoEvent._lastSavedStateFlag.

Referenced by Vispa.Share.UndoEvent.UndoEvent.dump().

41  def isLastSavedState(self):
42  """ Returns the last saved state flag, see setLastSavedState().
43  """
44  if hasattr(self, "_lastSavedStateFlag"):
45  return self._lastSavedStateFlag
46  return False
47 
def Vispa.Share.UndoEvent.UndoEvent.redo (   self)
Repeats this event.

Definition at line 14 of file UndoEvent.py.

14  def redo(self):
15  """ Repeats this event.
16  """
17  raise NotImplementedError
18 
def Vispa.Share.UndoEvent.UndoEvent.setLastSavedState (   self,
  flag 
)
Sets the last saved state flag.

If the flag is True, this UndoEvent represents the first action 
after saving the file for the last time.

Definition at line 33 of file UndoEvent.py.

33  def setLastSavedState(self, flag):
34  """ Sets the last saved state flag.
35 
36  If the flag is True, this UndoEvent represents the first action
37  after saving the file for the last time.
38  """
39  self._lastSavedStateFlag = flag
40 
def setLastSavedState(self, flag)
Definition: UndoEvent.py:33
def Vispa.Share.UndoEvent.UndoEvent.undo (   self)
Undos this event.

Definition at line 9 of file UndoEvent.py.

9  def undo(self):
10  """ Undos this event.
11  """
12  raise NotImplementedError
13 

Member Data Documentation

Vispa.Share.UndoEvent.UndoEvent._lastSavedStateFlag
private

Definition at line 39 of file UndoEvent.py.

Referenced by Vispa.Share.UndoEvent.UndoEvent.isLastSavedState().