Back to index

lightning-sunbird  0.9+nobinonly
nsIDOMNSHTMLDocument.idl
Go to the documentation of this file.
00001 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2000
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Vidur Apparao <vidur@netscape.com> (original author)
00024  *   Johnny Stenback <jst@netscape.com>
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 #include "domstubs.idl"
00041 
00042 [scriptable, uuid(79beb289-3644-4b54-9432-9fb993945629)]
00043 interface nsIDOMNSHTMLDocument : nsISupports
00044 {
00045   readonly attribute long                 width;
00046   readonly attribute long                 height;
00047            attribute DOMString            alinkColor;
00048            attribute DOMString            linkColor;
00049            attribute DOMString            vlinkColor;
00050            attribute DOMString            bgColor;
00051            attribute DOMString            fgColor;
00052            attribute DOMString            domain;
00053 
00054   readonly attribute nsIDOMHTMLCollection embeds;
00055 
00056   DOMString                 getSelection();
00057 
00058   // This is the internal version of open(); note that the version
00059   // scriptable with JS is defined entirely in classinfo.
00060   // If aContentType is not something supported by nsHTMLDocument and
00061   // the HTML content sink, trying to write to the document will
00062   // probably throw.
00063   // Pass aReplace = true to trigger a replacement of the previous
00064   // document in session history; pass false for normal history handling.
00065   nsIDOMDocument            open(in ACString aContentType,
00066                                  in boolean aReplace);
00067 
00068   // Scriptable versions of write(), writeln(), clear().
00069   void                      write();
00070   void                      writeln();
00071   void                      clear();
00072 
00076   void                      captureEvents(in long eventFlags);
00077   void                      releaseEvents(in long eventFlags);
00078   void                      routeEvent(in nsIDOMEvent evt);
00079 
00080   // returns "BackCompat" if we're in quirks mode,
00081   // or "CSS1Compat" if we're in strict mode
00082   readonly attribute DOMString            compatMode;
00083 
00084   // mapped to attribute embeds for NS4 compat
00085   readonly attribute nsIDOMHTMLCollection plugins;
00086   
00087 
00091   attribute DOMString       designMode;
00092 
00093   boolean                   execCommand(in DOMString commandID,
00094                                         in boolean doShowUI,
00095                                         in DOMString value);
00096 
00097   // returns true if the help is being shown for command (false if not)
00098   boolean                   execCommandShowHelp(in DOMString commandID);
00099 
00100   // returns true if the command is enabled (false otherwise)
00101   boolean                   queryCommandEnabled(in DOMString commandID);
00102   
00103   // returns true if the command is in a indeterminate state (false otherwise)
00104   boolean                   queryCommandIndeterm(in DOMString commandID);
00105 
00106   // returns true if the command has been executed (false otherwise)
00107   boolean                   queryCommandState(in DOMString commandID);
00108 
00109   // returns true if the command is supported on the current range
00110   boolean                   queryCommandSupported(in DOMString commandID);
00111 
00112   //
00113   DOMString                 queryCommandText(in DOMString commandID);
00114 
00115   // returns the current value of the document or current selection for command
00116   DOMString                 queryCommandValue(in DOMString commandID);
00117 };