diff options
author | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
---|---|---|
committer | Matt A. Tobin <mattatobin@localhost.localdomain> | 2018-02-02 04:16:08 -0500 |
commit | 5f8de423f190bbb79a62f804151bc24824fa32d8 (patch) | |
tree | 10027f336435511475e392454359edea8e25895d /editor/txmgr/nsITransactionList.idl | |
parent | 49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff) | |
download | UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip |
Add m-esr52 at 52.6.0
Diffstat (limited to 'editor/txmgr/nsITransactionList.idl')
-rw-r--r-- | editor/txmgr/nsITransactionList.idl | 70 |
1 files changed, 70 insertions, 0 deletions
diff --git a/editor/txmgr/nsITransactionList.idl b/editor/txmgr/nsITransactionList.idl new file mode 100644 index 000000000..de6d191de --- /dev/null +++ b/editor/txmgr/nsITransactionList.idl @@ -0,0 +1,70 @@ +/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ +/* This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#include "nsISupports.idl" + +interface nsITransaction; + +/* + * The nsITransactionList interface. + * <P> + * The implementation for this interface is provided by the Transaction Manager. + * This interface provides a mechanism for accessing the transactions on the + * Undo or Redo stacks as well as any auto-aggregated children that a + * transaction may have. + */ +[scriptable, uuid(d007ceff-c978-486a-b697-384ca01997be)] + +interface nsITransactionList : nsISupports +{ + /** + * The number of transactions contained in this list. + */ + readonly attribute long numItems; + + /** + * itemIsBatch() returns true if the item at aIndex is a batch. Note that + * currently there is no requirement for a TransactionManager implementation + * to associate a toplevel nsITransaction with a batch so it is possible for + * itemIsBatch() to return true and getItem() to return null. However, you + * can still access the transactions contained in the batch with a call to + * getChildListForItem(). + * @param aIndex The index of the item in the list. + */ + boolean itemIsBatch(in long aIndex); + + /** + * getItem() returns the transaction at the given index in the list. Note that + * a null can be returned here if the item is a batch. The transaction + * returned is AddRef'd so it is up to the caller to Release the transaction + * when it is done. + * @param aIndex The index of the item in the list. + */ + nsITransaction getItem(in long aIndex); + + /** + * getData() returns the data (of type nsISupports array) associated with + * the transaction list. + */ + void getData(in long aIndex, [optional] out unsigned long aLength, + [array, size_is(aLength), retval] out nsISupports aData); + + /** + * getNumChildrenForItem() returns the number of child (auto-aggreated) + * transactions the item at aIndex has. + * @param aIndex The index of the item in the list. + */ + long getNumChildrenForItem(in long aIndex); + + /** + * getChildListForItem() returns the list of children associated with the + * item at aIndex. Implementations may return null if there are no children, + * or an empty list. The list returned is AddRef'd so it is up to the caller + * to Release the transaction when it is done. + * @param aIndex The index of the item in the list. + */ + nsITransactionList getChildListForItem(in long aIndex); +}; + |