editor/idl/nsIHTMLInlineTableEditor.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla.org.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corp.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Daniel Glazman (glazman@netscape.com) (Original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40 #include "domstubs.idl"
  41
  42 [scriptable, uuid(eda2e65c-a758-451f-9b05-77cb8de74ed2)]
  43
  44 interface nsIHTMLInlineTableEditor : nsISupports
  45 {
  46   /**
  47    * boolean indicating if inline table editing is enabled in the editor.
  48    * When inline table editing is enabled, and when the selection is
  49    * contained in a table cell, special buttons allowing to add/remove
  50    * a line/column are available on the cell's border.
  51    */
  52   attribute boolean inlineTableEditingEnabled;
  53
  54   /**
  55    * Shows inline table editing UI around a table cell
  56    * @param aCell [IN] a DOM Element being a table cell, td or th
  57    */
  58   void showInlineTableEditingUI(in nsIDOMElement aCell);
  59
  60   /**
  61    * Hide all inline table editing UI
  62    */
  63   void hideInlineTableEditingUI();
  64
  65   /**
  66    * Modifies the table containing the selection according to the
  67    * activation of an inline table editing UI element
  68    * @param aUIAnonymousElement [IN] the inline table editing UI element
  69    */
  70   void doInlineTableEditingAction(in nsIDOMElement aUIAnonymousElement);
  71
  72   /**
  73    * Refresh already visible inline table editing UI
  74    */
  75   void refreshInlineTableEditingUI();
  76 };
  77