nsITransactionListener

by 3 contributors:

This interface is implemented by an object that tracks transactions.
Inherits from: nsISupports Last changed in Gecko 1.7

Method overview

void didBeginBatch(in nsITransactionManager aManager, in nsresult aResult);
void didDo(in nsITransactionManager aManager, in nsITransaction aTransaction, in nsresult aDoResult);
void didEndBatch(in nsITransactionManager aManager, in nsresult aResult);
void didMerge(in nsITransactionManager aManager, in nsITransaction aTopTransaction, in nsITransaction aTransactionToMerge, in boolean aDidMerge, in nsresult aMergeResult);
void didRedo(in nsITransactionManager aManager, in nsITransaction aTransaction, in nsresult aRedoResult);
void didUndo(in nsITransactionManager aManager, in nsITransaction aTransaction, in nsresult aUndoResult);
boolean willBeginBatch(in nsITransactionManager aManager);
boolean willDo(in nsITransactionManager aManager, in nsITransaction aTransaction);
boolean willEndBatch(in nsITransactionManager aManager);
boolean willMerge(in nsITransactionManager aManager, in nsITransaction aTopTransaction, in nsITransaction aTransactionToMerge);
boolean willRedo(in nsITransactionManager aManager, in nsITransaction aTransaction);
boolean willUndo(in nsITransactionManager aManager, in nsITransaction aTransaction);

Methods

didBeginBatch()

Called after a nsITransactionManager begins a batch.

void didBeginBatch(
  in nsITransactionManager aManager,
  in nsresult aResult
);
Parameters
aManager
The nsITransactionManager that began a batch.
aResult
The nsresult returned after beginning a batch.

didDo()

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

void didDo(
  in nsITransactionManager aManager,
  in nsITransaction aTransaction,
  in nsresult aDoResult
);
Parameters
aManager
The nsITransactionManager that did the transaction.
aTransaction
The transaction that was executed.
aDoResult
The nsresult returned after executing the transaction.

didEndBatch()

Called after a nsITransactionManager ends a batch.

void didEndBatch(
  in nsITransactionManager aManager,
  in nsresult aResult
);
Parameters
aManager
The nsITransactionManager ending a batch.
aResult
The nsresult returned after ending a batch.

didMerge()

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

void didMerge(
  in nsITransactionManager aManager,
  in nsITransaction aTopTransaction,
  in nsITransaction aTransactionToMerge,
  in boolean aDidMerge,
  in nsresult aMergeResult
);
Parameters
aManager
The nsITransactionManager ending a batch.
aTopTransaction
The transaction at the top of the undo stack.
aTransactionToMerge
The transaction to merge.
aDidMerge
true if transaction was merged, else false.
aMergeResult
The nsresult returned after the merge attempt.

didRedo()

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

void didRedo(
  in nsITransactionManager aManager,
  in nsITransaction aTransaction,
  in nsresult aRedoResult
);
Parameters
aManager
The nsITransactionManager redoing the transaction.
aTransaction
The transaction being redone.
aRedoResult
The nsresult returned after redoing the transaction.

didUndo()

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

void didUndo(
  in nsITransactionManager aManager,
  in nsITransaction aTransaction,
  in nsresult aUndoResult
);
Parameters
aManager
The nsITransactionManager undoing the transaction.
aTransaction
The transaction being undone.
aUndoResult
The nsresult returned after undoing the transaction.

willBeginBatch()

Called before a nsITransactionManager begins a batch.

boolean willBeginBatch(
  in nsITransactionManager aManager
);
Parameters
aManager
The nsITransactionManager beginning a batch.
Return value

 

willDo()

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

boolean willDo(
  in nsITransactionManager aManager,
  in nsITransaction aTransaction
);
Parameters
aManager
The nsITransactionManager doing the transaction.
aTransaction
The transaction being executed.
Return value

 

willEndBatch()

Called before a nsITransactionManager ends a batch.

boolean willEndBatch(
  in nsITransactionManager aManager
);
Parameters
aManager
The nsITransactionManager ending a batch.
Return value

 

willMerge()

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

boolean willMerge(
  in nsITransactionManager aManager,
  in nsITransaction aTopTransaction,
  in nsITransaction aTransactionToMerge
);
Parameters
aManager
The nsITransactionManager ending a batch.
aTopTransaction
The transaction at the top of the undo stack.
aTransactionToMerge
The transaction to merge.
Return value

 

willRedo()

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

boolean willRedo(
  in nsITransactionManager aManager,
  in nsITransaction aTransaction
);
Parameters
aManager
The nsITransactionManager redoing the transaction.
aTransaction
The transaction being redone.
Return value

 

willUndo()

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

boolean willUndo(
  in nsITransactionManager aManager,
  in nsITransaction aTransaction
);
Parameters
aManager
The nsITransactionManager undoing the transaction.
aTransaction
The transaction being undone.
Return value

 

See also

Document Tags and Contributors

Contributors to this page: Sheppy, syssgx, trevorh
Last updated by: Sheppy,