Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions
nsITransactionListener Interface Reference

The nsITransactionListener interface. More...

import "nsITransactionListener.idl";

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

List of all members.

Public Member Functions

boolean willDo (in nsITransactionManager aManager, in nsITransaction aTransaction)
 Called before a transaction manager calls a transaction's doTransaction() method.
void didDo (in nsITransactionManager aManager, in nsITransaction aTransaction, in nsresult aDoResult)
 Called after a transaction manager calls the doTransaction() method of a transaction.
boolean willUndo (in nsITransactionManager aManager, in nsITransaction aTransaction)
 Called before a transaction manager calls the Undo() method of a transaction.
void didUndo (in nsITransactionManager aManager, in nsITransaction aTransaction, in nsresult aUndoResult)
 Called after a transaction manager calls the Undo() method of a transaction.
boolean willRedo (in nsITransactionManager aManager, in nsITransaction aTransaction)
 Called before a transaction manager calls the Redo() method of a transaction.
void didRedo (in nsITransactionManager aManager, in nsITransaction aTransaction, in nsresult aRedoResult)
 Called after a transaction manager calls the Redo() method of a transaction.
boolean willBeginBatch (in nsITransactionManager aManager)
 Called before a transaction manager begins a batch.
void didBeginBatch (in nsITransactionManager aManager, in nsresult aResult)
 Called after a transaction manager begins a batch.
boolean willEndBatch (in nsITransactionManager aManager)
 Called before a transaction manager ends a batch.
void didEndBatch (in nsITransactionManager aManager, in nsresult aResult)
 Called after a transaction manager ends a batch.
boolean willMerge (in nsITransactionManager aManager, in nsITransaction aTopTransaction, in nsITransaction aTransactionToMerge)
 Called before a transaction manager 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)
 Called after a transaction manager tries to merge a transaction, that was just executed, with the transaction at the top of the undo stack.

Detailed Description

The nsITransactionListener interface.

This interface is implemented by an object that tracks transactions.

Definition at line 49 of file nsITransactionListener.idl.


Member Function Documentation

Called after a transaction manager begins a batch.

Parameters:
aManagerthe transaction manager that began a batch.
aResultthe nsresult returned after beginning a batch.
void nsITransactionListener::didDo ( in nsITransactionManager  aManager,
in nsITransaction  aTransaction,
in nsresult  aDoResult 
)

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

Parameters:
aManagerthe transaction manager that did the transaction.
aTransactionthe transaction that was executed.
aDoResultthe nsresult returned after executing the transaction.

Called after a transaction manager ends a batch.

Parameters:
aManagerthe transaction manager ending a batch.
aResultthe nsresult returned after ending a batch.
void nsITransactionListener::didMerge ( in nsITransactionManager  aManager,
in nsITransaction  aTopTransaction,
in nsITransaction  aTransactionToMerge,
in boolean  aDidMerge,
in nsresult  aMergeResult 
)

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

Parameters:
aManagerthe transaction manager ending a batch.
aTopTransactionthe transaction at the top of the undo stack.
aTransactionToMergethe transaction to merge.
aDidMergetrue if transaction was merged, else false.
aMergeResultthe nsresult returned after the merge attempt.
aInterruptlisteners should set this to PR_TRUE if they want to interrupt normal control flow, without throwing an error.
void nsITransactionListener::didRedo ( in nsITransactionManager  aManager,
in nsITransaction  aTransaction,
in nsresult  aRedoResult 
)

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

Parameters:
aManagerthe transaction manager redoing the transaction.
aTransactionthe transaction being redone.
aRedoResultthe nsresult returned after redoing the transaction.
void nsITransactionListener::didUndo ( in nsITransactionManager  aManager,
in nsITransaction  aTransaction,
in nsresult  aUndoResult 
)

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

Parameters:
aManagerthe transaction manager undoing the transaction.
aTransactionthe transaction being undone.
aUndoResultthe nsresult returned after undoing the transaction.

Called before a transaction manager begins a batch.

Parameters:
aManagerthe transaction manager beginning a batch.
Returns:
boolean value returned by listener which indicates it's desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error. Note that listeners can also interrupt normal control flow by throwing an nsresult that indicates an error.

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

Parameters:
aManagerthe transaction manager doing the transaction.
aTransactionthe transaction being executed.
Returns:
boolean value returned by listener which indicates it's desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error.

Called before a transaction manager ends a batch.

Parameters:
aManagerthe transaction manager ending a batch.
Returns:
boolean value returned by listener which indicates it's desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error. Note that listeners can also interrupt normal control flow by throwing an nsresult that indicates an error.
boolean nsITransactionListener::willMerge ( in nsITransactionManager  aManager,
in nsITransaction  aTopTransaction,
in nsITransaction  aTransactionToMerge 
)

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

Parameters:
aManagerthe transaction manager ending a batch.
aTopTransactionthe transaction at the top of the undo stack.
aTransactionToMergethe transaction to merge.
Returns:
boolean value returned by listener which indicates it's desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error. Note that listeners can also interrupt normal control flow by throwing an nsresult that indicates an error.

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

Parameters:
aManagerthe transaction manager redoing the transaction.
aTransactionthe transaction being redone.
Returns:
boolean value returned by listener which indicates it's desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error. Note that listeners can also interrupt normal control flow by throwing an nsresult that indicates an error.

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

Parameters:
aManagerthe transaction manager undoing the transaction.
aTransactionthe transaction being undone.
Returns:
boolean value returned by listener which indicates it's desire to interrupt normal control flow. Listeners should return true if they want to interrupt normal control flow, without throwing an error. Note that listeners can also interrupt normal control flow by throwing an nsresult that indicates an error.

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