WARNING: Most of this content (with the exception of the Mozilla 1.9 XPCOM reference) is very old, and can be expected to be out of date and possibly obsolete. For better XUL documentation, please visit the XUL hub at the Mozilla Developer Center.

nsITransactionListener

IID:58e330c4-7b48-11d2-98b9-00805f297d89
Inherits From:nsISupports

The nsITransactionListener interface.

This interface is implemented by an object that tracks transactions.


Methods

void didBeginBatch ( nsITransactionManager manager , nsresult result ) void didDo ( nsITransactionManager manager , nsITransaction transaction , nsresult doResult ) void didEndBatch ( nsITransactionManager manager , nsresult result ) void didMerge ( nsITransactionManager manager , nsITransaction topTransaction , nsITransaction transactionToMerge , PRBool didMerge , nsresult mergeResult ) void didRedo ( nsITransactionManager manager , nsITransaction transaction , nsresult redoResult ) void didUndo ( nsITransactionManager manager , nsITransaction transaction , nsresult undoResult ) PRBool willBeginBatch ( nsITransactionManager manager ) PRBool willDo ( nsITransactionManager manager , nsITransaction transaction ) PRBool willEndBatch ( nsITransactionManager manager ) PRBool willMerge ( nsITransactionManager manager , nsITransaction topTransaction , nsITransaction transactionToMerge ) PRBool willRedo ( nsITransactionManager manager , nsITransaction transaction ) PRBool willUndo ( nsITransactionManager manager , nsITransaction transaction )

void didBeginBatch ( nsITransactionManager manager , nsresult result )

Called after a transaction manager begins a batch.

Arguments:
manager: the transaction manager that began a batch.
result: the nsresult returned after beginning a batch.

void didDo ( nsITransactionManager manager , nsITransaction transaction , nsresult doResult )

Called after a transaction manager calls the doTransaction() method of a transaction.

Arguments:
manager: the transaction manager that did the transaction.
transaction: the transaction that was executed.
doResult: the nsresult returned after executing the transaction.

void didEndBatch ( nsITransactionManager manager , nsresult result )

Called after a transaction manager ends a batch.

Arguments:
manager: the transaction manager ending a batch.
result: the nsresult returned after ending a batch.

void didMerge ( nsITransactionManager manager , nsITransaction topTransaction , nsITransaction transactionToMerge , PRBool didMerge , nsresult mergeResult )

Called after a transaction manager tries to merge a transaction, that was just executed, with the transaction at the top of the undo stack.

Arguments:
manager: the transaction manager ending a batch.
topTransaction: the transaction at the top of the undo stack.
transactionToMerge: the transaction to merge.
didMerge: true if transaction was merged, else false.
mergeResult: the nsresult returned after the merge attempt.

void didRedo ( nsITransactionManager manager , nsITransaction transaction , nsresult redoResult )

Called after a transaction manager calls the Redo() method of a transaction.

Arguments:
manager: the transaction manager redoing the transaction.
transaction: the transaction being redone.
redoResult: the nsresult returned after redoing the transaction.

void didUndo ( nsITransactionManager manager , nsITransaction transaction , nsresult undoResult )

Called after a transaction manager calls the Undo() method of a transaction.

Arguments:
manager: the transaction manager undoing the transaction.
transaction: the transaction being undone.
undoResult: the nsresult returned after undoing the transaction.

PRBool willBeginBatch ( nsITransactionManager manager )

Called before a transaction manager begins a batch.

Arguments:
manager: the transaction manager beginning a batch.

PRBool willDo ( nsITransactionManager manager , nsITransaction transaction )

Called before a transaction manager calls a transaction's doTransaction() method.

Arguments:
manager: the transaction manager doing the transaction.
transaction: the transaction being executed.

PRBool willEndBatch ( nsITransactionManager manager )

Called before a transaction manager ends a batch.

Arguments:
manager: the transaction manager ending a batch.

PRBool willMerge ( nsITransactionManager manager , nsITransaction topTransaction , nsITransaction transactionToMerge )

Called before a transaction manager tries to merge a transaction, that was just executed, with the transaction at the top of the undo stack.

Arguments:
manager: the transaction manager ending a batch.
topTransaction: the transaction at the top of the undo stack.
transactionToMerge: the transaction to merge.

PRBool willRedo ( nsITransactionManager manager , nsITransaction transaction )

Called before a transaction manager calls the Redo() method of a transaction.

Arguments:
manager: the transaction manager redoing the transaction.
transaction: the transaction being redone.

PRBool willUndo ( nsITransactionManager manager , nsITransaction transaction )

Called before a transaction manager calls the Undo() method of a transaction.

Arguments:
manager: the transaction manager undoing the transaction.
transaction: the transaction being undone.

References

This interface is passed as an argument to the following methods:

nsITransactionManager.AddListener, nsITransactionManager.RemoveListener

Reference documentation is generated from Mozilla's source.

Copyright © 1999-2006 XULPlanet.com