Source code

Revision control

Other Tools

/* -*- 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 */
#ifndef CompositionTransaction_h
#define CompositionTransaction_h
#include "mozilla/EditTransactionBase.h" // base class
#include "mozilla/EditorDOMPoint.h" // EditorDOMPointInText
#include "mozilla/WeakPtr.h"
#include "nsCycleCollectionParticipant.h" // various macros
#include "nsString.h" // mStringToInsert
namespace mozilla {
class EditorBase;
class TextComposition;
class TextRangeArray;
namespace dom {
class Text;
} // namespace dom
* CompositionTransaction stores all edit for a composition, i.e.,
* from compositionstart event to compositionend event. E.g., inserting a
* composition string, modifying the composition string or its IME selection
* ranges and commit or cancel the composition.
class CompositionTransaction final : public EditTransactionBase,
public SupportsWeakPtr {
CompositionTransaction(EditorBase& aEditorBase,
const nsAString& aStringToInsert,
const EditorDOMPointInText& aPointToInsert);
* Creates a composition transaction. aEditorBase must not return from
* GetComposition() while calling this method. Note that this method will
* update text node information of aEditorBase.mComposition.
* @param aEditorBase The editor which has composition.
* @param aStringToInsert The new composition string to insert. This may
* be different from actual composition string.
* E.g., password editor can hide the character
* with a different character.
* @param aPointToInsert The insertion point.
static already_AddRefed<CompositionTransaction> Create(
EditorBase& aEditorBase, const nsAString& aStringToInsert,
const EditorDOMPointInText& aPointToInsert);
MOZ_CAN_RUN_SCRIPT NS_IMETHOD RedoTransaction() override;
NS_IMETHOD Merge(nsITransaction* aOtherTransaction, bool* aDidMerge) override;
void MarkFixed();
MOZ_CAN_RUN_SCRIPT static nsresult SetIMESelection(
EditorBase& aEditorBase, dom::Text* aTextNode, uint32_t aOffsetInNode,
uint32_t aLengthOfCompositionString, const TextRangeArray* aRanges);
friend std::ostream& operator<<(std::ostream& aStream,
const CompositionTransaction& aTransaction);
virtual ~CompositionTransaction() = default;
MOZ_CAN_RUN_SCRIPT nsresult SetSelectionForRanges();
// The text element to operate upon.
RefPtr<dom::Text> mTextNode;
// The offsets into mTextNode where the insertion should be placed.
uint32_t mOffset;
uint32_t mReplaceLength;
// The range list.
RefPtr<TextRangeArray> mRanges;
// The text to insert into mTextNode at mOffset.
nsString mStringToInsert;
// The editor, which is used to get the selection controller.
RefPtr<EditorBase> mEditorBase;
bool mFixed;
} // namespace mozilla
#endif // #ifndef CompositionTransaction_h