editor/nsIDocumentStateListener.idl

   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 #include "nsISupports.idl"
   7
   8 /**
   9  * Due to the historical reason, this listener interface says "document state",
  10  * but this listener listens to HTML editor state.
  11  */
  12 [scriptable, uuid(050cdc00-3b8e-11d3-9ce4-a458f454fcbc)]
  13 interface nsIDocumentStateListener : nsISupports
  14 {
  15   /**
  16    * NotifyDocumentWillBeDestroyed() is called when HTML editor instance is
  17    * being destroyed.  Note that related objects may have already gone when
  18    * this is called because that may cause destroying HTML editor.
  19    */
  20   [can_run_script]
  21   void NotifyDocumentWillBeDestroyed();
  22
  23   /**
  24    * NotifyDocumentStateChanged() is called when dirty state of HTML editor
  25    * is changed.
  26    *
  27    * @param aNowDirty   if true, this is called when the HTML editor becomes
  28    *                    dirty.  Otherwise, called when it becomes not dirty.
  29    */
  30   [can_run_script]
  31   void NotifyDocumentStateChanged(in boolean aNowDirty);
  32 };