1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 : /* ***** BEGIN LICENSE BLOCK *****
3 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 : *
5 : * The contents of this file are subject to the Mozilla Public License Version
6 : * 1.1 (the "License"); you may not use this file except in compliance with
7 : * the License. You may obtain a copy of the License at
8 : * http://www.mozilla.org/MPL/
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-1999
20 : * the Initial Developer. All Rights Reserved.
21 : *
22 : * Contributor(s):
23 : *
24 : * Alternatively, the contents of this file may be used under the terms of
25 : * either of the GNU General Public License Version 2 or later (the "GPL"),
26 : * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 : * in which case the provisions of the GPL or the LGPL are applicable instead
28 : * of those above. If you wish to allow use of your version of this file only
29 : * under the terms of either the GPL or the LGPL, and not to allow others to
30 : * use your version of this file under the terms of the MPL, indicate your
31 : * decision by deleting the provisions above and replace them with the notice
32 : * and other provisions required by the GPL or the LGPL. If you do not delete
33 : * the provisions above, a recipient may use your version of this file under
34 : * the terms of any one of the MPL, the GPL or the LGPL.
35 : *
36 : * ***** END LICENSE BLOCK ***** */
37 :
38 : #ifndef ChangeAttributeTxn_h__
39 : #define ChangeAttributeTxn_h__
40 :
41 : #include "EditTxn.h"
42 : #include "nsCOMPtr.h"
43 : #include "nsIDOMElement.h"
44 : #include "nsIEditor.h"
45 :
46 : /**
47 : * A transaction that changes an attribute of a content node.
48 : * This transaction covers add, remove, and change attribute.
49 : */
50 : class ChangeAttributeTxn : public EditTxn
51 0 : {
52 : public:
53 : /** Initialize the transaction.
54 : * @param aEditor the object providing core editing operations
55 : * @param aNode the node whose attribute will be changed
56 : * @param aAttribute the name of the attribute to change
57 : * @param aValue the new value for aAttribute, if aRemoveAttribute is false
58 : * @param aRemoveAttribute if true, remove aAttribute from aNode
59 : */
60 : NS_IMETHOD Init(nsIEditor *aEditor,
61 : nsIDOMElement *aNode,
62 : const nsAString& aAttribute,
63 : const nsAString& aValue,
64 : bool aRemoveAttribute);
65 :
66 : ChangeAttributeTxn();
67 :
68 : NS_DECL_ISUPPORTS_INHERITED
69 1464 : NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(ChangeAttributeTxn, EditTxn)
70 :
71 : NS_DECL_EDITTXN
72 :
73 : NS_IMETHOD RedoTransaction();
74 :
75 : protected:
76 :
77 : /** the editor that created this transaction */
78 : nsIEditor* mEditor;
79 :
80 : /** the element to operate upon */
81 : nsCOMPtr<nsIDOMElement> mElement;
82 :
83 : /** the attribute to change */
84 : nsString mAttribute;
85 :
86 : /** the value to set the attribute to (ignored if mRemoveAttribute==true) */
87 : nsString mValue;
88 :
89 : /** the value to set the attribute to for undo */
90 : nsString mUndoValue;
91 :
92 : /** true if the mAttribute was set on mElement at the time of execution */
93 : bool mAttributeWasSet;
94 :
95 : /** true if the operation is to remove mAttribute from mElement */
96 : bool mRemoveAttribute;
97 : };
98 :
99 : #endif
|