Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsITransactionManager Interface Reference

The nsITransactionManager interface. More...

import "nsITransactionManager.idl";

Inheritance diagram for nsITransactionManager:
Inheritance graph
[legend]
Collaboration diagram for nsITransactionManager:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void doTransaction (in nsITransaction aTransaction)
 Calls a transaction's doTransaction() method, then pushes it on the undo stack.
void undoTransaction ()
 Pops the topmost transaction on the undo stack, calls it's undoTransaction() method, then pushes it on the redo stack.
void redoTransaction ()
 Pops the topmost transaction on the redo stack, calls it's redoTransaction() method, then pushes it on the undo stack.
void clear ()
 Clears the undo and redo stacks.
void beginBatch ()
 Turns on the transaction manager's batch mode, forcing all transactions executed by the transaction manager's doTransaction() method to be aggregated together until EndBatch() is called.
void endBatch ()
 Turns off the transaction manager's batch mode.
nsITransaction peekUndoStack ()
 Returns an AddRef'd pointer to the transaction at the top of the undo stack.
nsITransaction peekRedoStack ()
 Returns an AddRef'd pointer to the transaction at the top of the redo stack.
nsITransactionList getUndoList ()
 Returns the list of transactions on the undo stack.
nsITransactionList getRedoList ()
 Returns the list of transactions on the redo stack.
void AddListener (in nsITransactionListener aListener)
 Adds a listener to the transaction manager's notification list.
void RemoveListener (in nsITransactionListener aListener)
 Removes a listener from the transaction manager's notification list.

Public Attributes

readonly attribute long numberOfUndoItems
 The number of items on the undo stack.
readonly attribute long numberOfRedoItems
 The number of items on the redo stack.
attribute long maxTransactionCount
 Sets the maximum number of transaction items the transaction manager will maintain at any time.

Detailed Description

The nsITransactionManager interface.

This interface is implemented by an object that wants to manage/track transactions.

Definition at line 56 of file nsITransactionManager.idl.


Member Function Documentation

Adds a listener to the transaction manager's notification list.

Listeners are notified whenever a transaction is done, undone, or redone.

The listener's AddRef() method is called.

Parameters:
aListenerthe lister to add.

Turns on the transaction manager's batch mode, forcing all transactions executed by the transaction manager's doTransaction() method to be aggregated together until EndBatch() is called.

This mode allows an application to execute and group together several independent transactions so they can be undone with a single call to undoTransaction().

Clears the undo and redo stacks.

Calls a transaction's doTransaction() method, then pushes it on the undo stack.

This method calls the transaction's AddRef() method. The transaction's Release() method will be called when the undo or redo stack is pruned or when the transaction manager is destroyed.

Parameters:
aTransactionthe transaction to do.

Turns off the transaction manager's batch mode.

Returns the list of transactions on the redo stack.

Note that the transaction at the top of the redo stack will actually be at the index 'n-1' in the list, where 'n' is the number of items in the list.

Returns the list of transactions on the undo stack.

Note that the transaction at the top of the undo stack will actually be at the index 'n-1' in the list, where 'n' is the number of items in the list.

Returns an AddRef'd pointer to the transaction at the top of the redo stack.

Callers should be aware that this method could return return a null in some implementations if there is a batch at the top of the redo stack.

Returns an AddRef'd pointer to the transaction at the top of the undo stack.

Callers should be aware that this method could return return a null in some implementations if there is a batch at the top of the undo stack.

Pops the topmost transaction on the redo stack, calls it's redoTransaction() method, then pushes it on the undo stack.

Removes a listener from the transaction manager's notification list.

The listener's Release() method is called.

Parameters:
aListenerthe lister to remove.

Pops the topmost transaction on the undo stack, calls it's undoTransaction() method, then pushes it on the redo stack.


Member Data Documentation

Sets the maximum number of transaction items the transaction manager will maintain at any time.

This is commonly referred to as the number of levels of undo.

Parameters:
aMaxCountA value of -1 means no limit. A value of zero means the transaction manager will execute each transaction, then immediately release all references it has to the transaction without pushing it on the undo stack. A value greater than zero indicates the max number of transactions that can exist at any time on both the undo and redo stacks. This method will prune the necessary number of transactions on the undo and redo stacks if the value specified is less than the number of items that exist on both the undo and redo stacks.

Definition at line 123 of file nsITransactionManager.idl.

The number of items on the redo stack.

Definition at line 108 of file nsITransactionManager.idl.

The number of items on the undo stack.

Definition at line 103 of file nsITransactionManager.idl.


The documentation for this interface was generated from the following file: