1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* This Source Code Form is subject to the terms of the Mozilla Public
3 * License, v. 2.0. If a copy of the MPL was not distributed with this
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6 #ifndef DeleteTextTransaction_h
7 #define DeleteTextTransaction_h
9 #include "mozilla/EditTransactionBase.h"
10 #include "mozilla/dom/Text.h"
12 #include "nsCycleCollectionParticipant.h"
23 * A transaction that removes text from a content node.
25 class DeleteTextTransaction final
: public EditTransactionBase
{
27 DeleteTextTransaction(EditorBase
& aEditorBase
, dom::Text
& aTextNode
,
28 uint32_t aOffset
, uint32_t aLengthToDelete
);
32 * Creates a delete text transaction to remove given range. This returns
33 * nullptr if it cannot modify the text node.
35 * @param aEditorBase The provider of basic editing operations.
36 * @param aTextNode The content node to remove text from.
37 * @param aOffset The location in aElement to begin the deletion.
38 * @param aLenthToDelete The length to delete.
40 static already_AddRefed
<DeleteTextTransaction
> MaybeCreate(
41 EditorBase
& aEditorBase
, dom::Text
& aTextNode
, uint32_t aOffset
,
42 uint32_t aLengthToDelete
);
45 * Creates a delete text transaction to remove a previous or next character.
46 * Those methods MAY return nullptr.
48 * @param aEditorBase The provider of basic editing operations.
49 * @param aTextNode The content node to remove text from.
50 * @param aOffset The location in aElement to begin the deletion.
52 static already_AddRefed
<DeleteTextTransaction
>
53 MaybeCreateForPreviousCharacter(EditorBase
& aEditorBase
, dom::Text
& aTextNode
,
55 static already_AddRefed
<DeleteTextTransaction
> MaybeCreateForNextCharacter(
56 EditorBase
& aEditorBase
, dom::Text
& aTextNode
, uint32_t aOffset
);
59 * CanDoIt() returns true if there are enough members and can modify the
60 * text. Otherwise, false.
64 NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(DeleteTextTransaction
,
66 NS_IMETHOD
QueryInterface(REFNSIID aIID
, void** aInstancePtr
) override
;
68 NS_DECL_EDITTRANSACTIONBASE
69 NS_DECL_EDITTRANSACTIONBASE_GETASMETHODS_OVERRIDE(DeleteTextTransaction
)
71 dom::Text
* GetText() const { return mTextNode
; }
72 uint32_t Offset() const { return mOffset
; }
73 uint32_t LengthToDelete() const { return mLengthToDelete
; }
76 // The provider of basic editing operations.
77 RefPtr
<EditorBase
> mEditorBase
;
79 // The CharacterData node to operate upon.
80 RefPtr
<dom::Text
> mTextNode
;
82 // The offset into mTextNode where the deletion is to take place.
85 // The length to delete.
86 uint32_t mLengthToDelete
;
88 // The text that was deleted.
89 nsString mDeletedText
;
92 } // namespace mozilla
94 #endif // #ifndef DeleteTextTransaction_h