dom/public/idl/html/nsIDOMNSHTMLDocument.idl

   1 /* -*- Mode: IDL; 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 code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2000
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Vidur Apparao <vidur@netscape.com> (original author)
  24  *   Johnny Stenback <jst@netscape.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "domstubs.idl"
  41
  42 [scriptable, uuid(79beb289-3644-4b54-9432-9fb993945629)]
  43 interface nsIDOMNSHTMLDocument : nsISupports
  44 {
  45   readonly attribute long                 width;
  46   readonly attribute long                 height;
  47            attribute DOMString            alinkColor;
  48            attribute DOMString            linkColor;
  49            attribute DOMString            vlinkColor;
  50            attribute DOMString            bgColor;
  51            attribute DOMString            fgColor;
  52            attribute DOMString            domain;
  53
  54   readonly attribute nsIDOMHTMLCollection embeds;
  55
  56   DOMString                 getSelection();
  57
  58   // This is the internal version of open(); note that the version
  59   // scriptable with JS is defined entirely in classinfo.
  60   // If aContentType is not something supported by nsHTMLDocument and
  61   // the HTML content sink, trying to write to the document will
  62   // probably throw.
  63   // Pass aReplace = true to trigger a replacement of the previous
  64   // document in session history; pass false for normal history handling.
  65   nsIDOMDocument            open(in ACString aContentType,
  66                                  in boolean aReplace);
  67
  68   // Scriptable versions of write(), writeln(), clear().
  69   void                      write();
  70   void                      writeln();
  71   void                      clear();
  72
  73   /**
  74    * @deprecated These are old Netscape 4 methods. Do not use,
  75    *             the implementation is no-op.
  76    */
  77   void                      captureEvents(in long eventFlags);
  78   void                      releaseEvents(in long eventFlags);
  79   void                      routeEvent(in nsIDOMEvent evt);
  80
  81   // returns "BackCompat" if we're in quirks mode,
  82   // or "CSS1Compat" if we're in strict mode
  83   readonly attribute DOMString            compatMode;
  84
  85   // mapped to attribute embeds for NS4 compat
  86   readonly attribute nsIDOMHTMLCollection plugins;
  87
  88
  89   /**
  90     * Midas additions
  91     */
  92   attribute DOMString       designMode;
  93
  94   boolean                   execCommand(in DOMString commandID,
  95                                         in boolean doShowUI,
  96                                         in DOMString value);
  97
  98   // returns true if the help is being shown for command (false if not)
  99   boolean                   execCommandShowHelp(in DOMString commandID);
 100
 101   // returns true if the command is enabled (false otherwise)
 102   boolean                   queryCommandEnabled(in DOMString commandID);
 103
 104   // returns true if the command is in a indeterminate state (false otherwise)
 105   boolean                   queryCommandIndeterm(in DOMString commandID);
 106
 107   // returns true if the command has been executed (false otherwise)
 108   boolean                   queryCommandState(in DOMString commandID);
 109
 110   // returns true if the command is supported on the current range
 111   boolean                   queryCommandSupported(in DOMString commandID);
 112
 113   //
 114   DOMString                 queryCommandText(in DOMString commandID);
 115
 116   // returns the current value of the document or current selection for command
 117   DOMString                 queryCommandValue(in DOMString commandID);
 118 };