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 DeleteTextTxn_h__
39 : #define DeleteTextTxn_h__
40 :
41 : #include "EditTxn.h"
42 : #include "nsIEditor.h"
43 : #include "nsIDOMCharacterData.h"
44 : #include "nsCOMPtr.h"
45 :
46 : class nsRangeUpdater;
47 :
48 : /**
49 : * A transaction that removes text from a content node.
50 : */
51 : class DeleteTextTxn : public EditTxn
52 0 : {
53 : public:
54 : /** initialize the transaction.
55 : * @param aEditor the provider of basic editing operations
56 : * @param aElement the content node to remove text from
57 : * @param aOffset the location in aElement to begin the deletion
58 : * @param aNumCharsToDelete the number of characters to delete. Not the number of bytes!
59 : */
60 : NS_IMETHOD Init(nsIEditor *aEditor,
61 : nsIDOMCharacterData *aElement,
62 : PRUint32 aOffset,
63 : PRUint32 aNumCharsToDelete,
64 : nsRangeUpdater *aRangeUpdater);
65 :
66 : DeleteTextTxn();
67 :
68 1464 : NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(DeleteTextTxn, EditTxn)
69 : NS_IMETHOD QueryInterface(REFNSIID aIID, void** aInstancePtr);
70 :
71 : NS_DECL_EDITTXN
72 :
73 0 : PRUint32 GetOffset() { return mOffset; }
74 :
75 0 : PRUint32 GetNumCharsToDelete() { return mNumCharsToDelete; }
76 :
77 : protected:
78 :
79 : /** the provider of basic editing operations */
80 : nsIEditor* mEditor;
81 :
82 : /** the text element to operate upon */
83 : nsCOMPtr<nsIDOMCharacterData> mElement;
84 :
85 : /** the offset into mElement where the deletion is to take place */
86 : PRUint32 mOffset;
87 :
88 : /** the number of characters to delete */
89 : PRUint32 mNumCharsToDelete;
90 :
91 : /** the text that was deleted */
92 : nsString mDeletedText;
93 :
94 : /** range updater object */
95 : nsRangeUpdater *mRangeUpdater;
96 : };
97 :
98 : #endif
|