← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/editor/txmgr/idl/nsITransaction.idl

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/editor/txmgr/idl/nsITransaction.idl
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
9
 *
 
10
 * Software distributed under the License is distributed on an "AS IS" basis,
 
11
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 
12
 * for the specific language governing rights and limitations under the
 
13
 * License.
 
14
 *
 
15
 * The Original Code is mozilla.org code.
 
16
 *
 
17
 * The Initial Developer of the Original Code is 
 
18
 * Netscape Communications Corporation.
 
19
 * Portions created by the Initial Developer are Copyright (C) 1998
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
23
 *
 
24
 *
 
25
 * Alternatively, the contents of this file may be used under the terms of
 
26
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 
27
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 
28
 * in which case the provisions of the GPL or the LGPL are applicable instead
 
29
 * of those above. If you wish to allow use of your version of this file only
 
30
 * under the terms of either the GPL or the LGPL, and not to allow others to
 
31
 * use your version of this file under the terms of the NPL, indicate your
 
32
 * decision by deleting the provisions above and replace them with the notice
 
33
 * and other provisions required by the GPL or the LGPL. If you do not delete
 
34
 * the provisions above, a recipient may use your version of this file under
 
35
 * the terms of any one of the NPL, the GPL or the LGPL.
 
36
 *
 
37
 * ***** END LICENSE BLOCK ***** */
 
38
 
 
39
#include "nsISupports.idl"
 
40
 
 
41
/*
 
42
 * The nsITransaction interface.
 
43
 * <P>
 
44
 * This interface is implemented by an object that needs to
 
45
 * execute some behavior that must be tracked by the transaction manager.
 
46
 */
 
47
[scriptable, uuid(58e330c1-7b48-11d2-98b9-00805f297d89)]
 
48
interface nsITransaction : nsISupports
 
49
{
 
50
  /**
 
51
   * Executes the transaction.
 
52
   */
 
53
  void doTransaction();
 
54
 
 
55
  /**
 
56
   * Restores the state to what it was before the transaction was executed.
 
57
   */
 
58
  void undoTransaction();
 
59
 
 
60
  /**
 
61
   * Executes the transaction again. Can only be called on a transaction that
 
62
   * was previously undone.
 
63
   * <P>
 
64
   * In most cases, the redoTransaction() method will actually call the
 
65
   * doTransaction() method to execute the transaction again.
 
66
   */
 
67
  void redoTransaction();
 
68
 
 
69
  /**
 
70
   * The transaction's transient state. This attribute is checked by
 
71
   * the transaction manager after the transaction's Execute() method is called.
 
72
   * If the transient state is false, a reference to the transaction is
 
73
   * held by the transaction manager so that the transactions' undoTransaction()
 
74
   * and redoTransaction() methods can be called. If the transient state is
 
75
   * true, the transaction manager returns immediately after the transaction's
 
76
   * doTransaction() method is called, no references to the transaction are
 
77
   * maintained. Transient transactions cannot be undone or redone by the
 
78
   * transaction manager.
 
79
   */
 
80
  readonly attribute boolean isTransient;
 
81
 
 
82
  /**
 
83
   * Attempts to merge a transaction into "this" transaction. Both transactions
 
84
   * must be in their undo state, doTransaction() methods already called. The
 
85
   * transaction manager calls this method to coalesce a new transaction with
 
86
   * the transaction on the top of the undo stack.
 
87
   * This method returns a boolean value that indicates the merge result.
 
88
   * A true value indicates that the transactions were merged successfully,
 
89
   * a false value if the merge was not possible or failed. If true,
 
90
   * the transaction manager will Release() the new transacton instead of
 
91
   * pushing it on the undo stack.
 
92
   * @param aTransaction the previously executed transaction to merge.
 
93
   */
 
94
  boolean merge(in nsITransaction aTransaction);
 
95
};
 
96