gecko-dev/editor/libeditor/InsertTextTransaction.h

96 строки
2.9 KiB
C++

/* -*- 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/. */
#ifndef InsertTextTransaction_h
#define InsertTextTransaction_h
#include "mozilla/EditTransactionBase.h" // base class
#include "nsCycleCollectionParticipant.h" // various macros
#include "nsID.h" // NS_DECLARE_STATIC_IID_ACCESSOR
#include "nsISupportsImpl.h" // NS_DECL_ISUPPORTS_INHERITED
#include "nsString.h" // nsString members
#include "nscore.h" // NS_IMETHOD, nsAString
class nsITransaction;
#define NS_INSERTTEXTTXN_IID \
{ 0x8c9ad77f, 0x22a7, 0x4d01, \
{ 0xb1, 0x59, 0x8a, 0x0f, 0xdb, 0x1d, 0x08, 0xe9 } }
namespace mozilla {
class EditorBase;
namespace dom {
class Text;
} // namespace dom
/**
* A transaction that inserts text into a content node.
*/
class InsertTextTransaction final : public EditTransactionBase
{
protected:
InsertTextTransaction(EditorBase& aEditorBase,
const nsAString& aStringToInsert,
dom::Text& aTextNode,
uint32_t aOffset);
public:
/**
* Creates new InsertTextTransaction instance. This never returns nullptr.
*
* @param aEditorBase The editor which manages the transaction.
* @param aTextNode The text content node to be inserted
* aStringToInsert.
* @param aOffset The offset in aTextNode to do the insertion.
* @param aStringToInsert The new string to insert.
*/
static already_AddRefed<InsertTextTransaction>
Create(EditorBase& aEditorBase,
const nsAString& aStringToInsert,
dom::Text& aTextNode,
uint32_t aOffset);
NS_DECLARE_STATIC_IID_ACCESSOR(NS_INSERTTEXTTXN_IID)
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(InsertTextTransaction,
EditTransactionBase)
NS_DECL_EDITTRANSACTIONBASE
NS_IMETHOD Merge(nsITransaction* aTransaction, bool* aDidMerge) override;
/**
* Return the string data associated with this transaction.
*/
void GetData(nsString& aResult);
private:
virtual ~InsertTextTransaction();
// Return true if aOtherTransaction immediately follows this transaction.
bool IsSequentialInsert(InsertTextTransaction& aOtherTrasaction);
// The Text node to operate upon.
RefPtr<dom::Text> mTextNode;
// The offset into mTextNode where the insertion is to take place.
uint32_t mOffset;
// The text to insert into mTextNode at mOffset.
nsString mStringToInsert;
// The editor, which we'll need to get the selection.
RefPtr<EditorBase> mEditorBase;
};
NS_DEFINE_STATIC_IID_ACCESSOR(InsertTextTransaction, NS_INSERTTEXTTXN_IID)
} // namespace mozilla
#endif // #ifndef InsertTextTransaction_h