Line data    Source code

       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/. */
       5             : 
       6             : #ifndef mozilla_EditTransactionBase_h
       7             : #define mozilla_EditTransactionBase_h
       8             : 
       9             : #include "nsCycleCollectionParticipant.h"
      10             : #include "nsISupportsImpl.h"
      11             : #include "nsITransaction.h"
      12             : #include "nsPIEditorTransaction.h"
      13             : #include "nscore.h"
      14             : 
      15             : namespace mozilla {
      16             : 
      17             : /**
      18             :  * Base class for all document editing transactions.
      19             :  */
      20           5 : class EditTransactionBase : public nsITransaction
      21             :                           , public nsPIEditorTransaction
      22             : {
      23             : public:
      24             :   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
      25          56 :   NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(EditTransactionBase, nsITransaction)
      26             : 
      27           6 :   virtual void LastRelease() {}
      28             : 
      29             :   NS_IMETHOD RedoTransaction(void) override;
      30             :   NS_IMETHOD GetIsTransient(bool* aIsTransient) override;
      31             :   NS_IMETHOD Merge(nsITransaction* aTransaction, bool* aDidMerge) override;
      32             : 
      33             : protected:
      34             :   virtual ~EditTransactionBase();
      35             : };
      36             : 
      37             : } // namespace mozilla
      38             : 
      39             : #define NS_DECL_EDITTRANSACTIONBASE \
      40             :   NS_IMETHOD DoTransaction() override; \
      41             :   NS_IMETHOD UndoTransaction() override; \
      42             :   NS_IMETHOD GetTxnDescription(nsAString& aTransactionDescription) override;
      43             : 
      44             : #endif // #ifndef mozilla_EditTransactionBase_h