fune/editor/libeditor/DeleteNodeTransaction.h
Masayuki Nakano 1abcb1c46b Bug 1764866 - Add "mozilla/EditorForwards.h" r=m_kato
Headers in editor module has a lot of forward declarations for avoiding the
include hell and has a lot of helper template classes.

Forward declarations of template classes is really messy and I'd want to
avoid the duplication because it blocks changing template class.  Therefore,
centralizing forward declarations makes the headers cleaner and maintaining
template classes easier.  Therefore, this patch adds a new header file which
has only forward declarations and some aliases.

It'd be better to define `enum class`es in it like `EventForwards.h` for
reducing the dependencies between headers, but currently this does not do it
for making the new file simpler as far as possible.

Removing `EditActionListener.h` is because it's unused.

Removing `AutoTopLevelEditSubActionNotifier` is because it's renamed to
`AutoEditSubActionNotifier`.
https://hg.mozilla.org/mozilla-central/rev/6de55c5b5f8d5f92389d0d244d2bced1f979ade9

Differential Revision: https://phabricator.services.mozilla.com/D143817
2022-04-20 14:46:16 +00:00

78 lines
2.2 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 DeleteNodeTransaction_h
#define DeleteNodeTransaction_h
#include "EditTransactionBase.h"
#include "EditorForwards.h"
#include "nsCOMPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsIContent.h"
#include "nsINode.h"
#include "nsISupportsImpl.h"
#include "nscore.h"
namespace mozilla {
/**
* A transaction that deletes a single element
*/
class DeleteNodeTransaction final : public EditTransactionBase {
protected:
DeleteNodeTransaction(EditorBase& aEditorBase, nsIContent& aContentToDelete);
public:
/**
* Creates a delete node transaction instance. This returns nullptr if
* it cannot remove the node from its parent.
*
* @param aEditorBase The editor.
* @param aContentToDelete The node to be removed from the DOM tree.
*/
static already_AddRefed<DeleteNodeTransaction> MaybeCreate(
EditorBase& aEditorBase, nsIContent& aContentToDelete);
/**
* CanDoIt() returns true if there are enough members and can modify the
* parent. Otherwise, false.
*/
bool CanDoIt() const;
NS_DECL_ISUPPORTS_INHERITED
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(DeleteNodeTransaction,
EditTransactionBase)
NS_DECL_EDITTRANSACTIONBASE
NS_DECL_EDITTRANSACTIONBASE_GETASMETHODS_OVERRIDE(DeleteNodeTransaction)
MOZ_CAN_RUN_SCRIPT NS_IMETHOD RedoTransaction() override;
nsIContent* GetContent() const { return mContentToDelete; }
friend std::ostream& operator<<(std::ostream& aStream,
const DeleteNodeTransaction& aTransaction);
protected:
virtual ~DeleteNodeTransaction() = default;
// The editor for this transaction.
RefPtr<EditorBase> mEditorBase;
// The element to delete.
nsCOMPtr<nsIContent> mContentToDelete;
// Parent of node to delete.
nsCOMPtr<nsINode> mParentNode;
// Next sibling to remember for undo/redo purposes.
nsCOMPtr<nsIContent> mRefContent;
};
} // namespace mozilla
#endif // #ifndef DeleteNodeTransaction_h