author Ryan VanderMeulen <>
Thu, 02 Jul 2015 16:00:46 -0400
changeset 270165 98101796b275e229828430c6c622085e6c21fece
parent 259839 db70fd907041471df8102f6bd4a3250078cda8c7
permissions -rw-r--r--
Merge m-c to fx-team. a=merge

/* -*- 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 */
#ifndef nsDocShellEditorData_h__
#define nsDocShellEditorData_h__

#ifndef nsCOMPtr_h___
#include "nsCOMPtr.h"

#include "nsIHTMLDocument.h"

class nsIDocShell;
class nsIEditingSession;
class nsIEditor;

class nsDocShellEditorData
  explicit nsDocShellEditorData(nsIDocShell* aOwningDocShell);

  nsresult MakeEditable(bool aWaitForUriLoad);
  bool GetEditable();
  nsresult CreateEditor();
  nsresult GetEditingSession(nsIEditingSession** aResult);
  nsresult GetEditor(nsIEditor** aResult);
  nsresult SetEditor(nsIEditor* aEditor);
  void TearDownEditor();
  nsresult DetachFromWindow();
  nsresult ReattachToWindow(nsIDocShell* aDocShell);
  bool WaitingForLoad() const { return mMakeEditable; }

  nsresult EnsureEditingSession();

  // The doc shell that owns us. Weak ref, since it always outlives us.
  nsIDocShell* mDocShell;

  // Only present for the content root docShell. Session is owned here.
  nsCOMPtr<nsIEditingSession> mEditingSession;

  // Indicates whether to make an editor after a url load.
  bool mMakeEditable;

  // If this frame is editable, store editor here. Editor is owned here.
  nsCOMPtr<nsIEditor> mEditor;

  // Denotes if the editor is detached from its window. The editor is detached
  // while it's stored in the session history bfcache.
  bool mIsDetached;

  // Backup for mMakeEditable while the editor is detached.
  bool mDetachedMakeEditable;

  // Backup for the corresponding nsIHTMLDocument's  editing state while
  // the editor is detached.
  nsIHTMLDocument::EditingState mDetachedEditingState;

#endif // nsDocShellEditorData_h__