editor/nsIEditorObserver.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 Editor Observer interface to outside world
  10 */
  11
  12 [scriptable, uuid(f3ee57a6-890c-4ce0-a584-8a84bba0292e)]
  13
  14 /**
  15  * A generic editor observer interface.
  16  * <P>
  17  * nsIEditorObserver is the interface used by applications wishing to be notified
  18  * when the editor has completed a user action.
  19  *
  20  */
  21 interface nsIEditorObserver : nsISupports {
  22   /**
  23    * Called after the editor completes a user action.
  24    */
  25   void EditAction();
  26   /**
  27    * Called when editor starts to handle a user action.  I.e., This must be
  28    * called before the first DOM change.
  29    */
  30   void BeforeEditAction();
  31   /**
  32    * Called after BeforeEditAction() is called but EditorAction() won't be
  33    * called.
  34    */
  35   void CancelEditAction();
  36 };