gecko-dev/dom/html/UndoManager.h
2015-05-03 15:32:37 -04:00

107 lines
3.0 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* 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 mozilla_dom_UndoManager_h
#define mozilla_dom_UndoManager_h
#include "mozilla/dom/UndoManagerBinding.h"
#include "nsCycleCollectionParticipant.h"
#include "nsCOMPtr.h"
#include "nsCOMArray.h"
#include "nsIContent.h"
#include "nsTArray.h"
#include "nsWrapperCache.h"
#include "mozilla/dom/Nullable.h"
class nsITransactionManager;
namespace mozilla {
class ErrorResult;
namespace dom {
class DOMTransaction;
class DOMTransactionCallback;
class UndoManager final : public nsISupports,
public nsWrapperCache
{
friend class TxnScopeGuard;
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(UndoManager)
explicit UndoManager(nsIContent* aNode);
void Transact(JSContext* aCx, DOMTransaction& aTransaction,
bool aMerge, ErrorResult& aRv);
void Undo(JSContext* aCx, ErrorResult& aRv);
void Redo(JSContext* acx, ErrorResult& aRv);
void Item(uint32_t aIndex,
Nullable<nsTArray<nsRefPtr<DOMTransaction> > >& aItems,
ErrorResult& aRv);
uint32_t GetLength(ErrorResult& aRv);
uint32_t GetPosition(ErrorResult& aRv);
void ClearUndo(ErrorResult& aRv);
void ClearRedo(ErrorResult& aRv);
void Disconnect();
nsISupports* GetParentObject() const
{
return mHostNode;
}
virtual JSObject* WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override
{
return mozilla::dom::UndoManagerBinding::Wrap(aCx, this, aGivenProto);
}
nsITransactionManager* GetTransactionManager();
protected:
virtual ~UndoManager();
nsCOMPtr<nsITransactionManager> mTxnManager;
nsCOMPtr<nsIContent> mHostNode;
/**
* Executes |aTransaction| as a manual transaction.
*/
void ManualTransact(DOMTransaction* aTransaction,
ErrorResult& aRv);
/**
* Executes |aTransaction| as an automatic transaction, calling
* aCallback to do the work.
*/
void AutomaticTransact(DOMTransaction* aTransaction,
DOMTransactionCallback* aCallback,
ErrorResult& aRv);
/**
* Appends the transactions in the undo transaction history at |aIndex|
* to the array |aItems|.
*/
void ItemInternal(uint32_t aIndex,
nsTArray<DOMTransaction*>& aItems,
ErrorResult& aRv);
/**
* Dispatches an event to the undo scope host.
* @param aPreviousPosition The index of the transaction that
* triggered the event.
*/
void DispatchTransactionEvent(JSContext* aCx, const nsAString& aType,
uint32_t aPreviousPosition,
ErrorResult& aRv);
bool mInTransaction;
bool mIsDisconnected;
};
} // namespace dom
} // namespace mozilla
#endif