Back to index

lightning-sunbird  0.9+nobinonly
mozIXMLTerminal.idl
Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00003  *
00004  * The contents of this file are subject to the Mozilla Public License Version
00005  * 1.1 (the "License"); you may not use this file except in compliance with
00006  * the License. You may obtain a copy of the License at
00007  * http://www.mozilla.org/MPL/
00008  *
00009  * Software distributed under the License is distributed on an "AS IS" basis,
00010  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00011  * for the specific language governing rights and limitations under the
00012  * License.
00013  *
00014  * The Original Code is XMLterm.
00015  *
00016  * The Initial Developer of the Original Code is
00017  * Ramalingam Saravanan.
00018  * Portions created by the Initial Developer are Copyright (C) 1999
00019  * the Initial Developer. All Rights Reserved.
00020  *
00021  * Contributor(s):
00022  *
00023  * Alternatively, the contents of this file may be used under the terms of
00024  * either the GNU General Public License Version 2 or later (the "GPL"), or
00025  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00026  * in which case the provisions of the GPL or the LGPL are applicable instead
00027  * of those above. If you wish to allow use of your version of this file only
00028  * under the terms of either the GPL or the LGPL, and not to allow others to
00029  * use your version of this file under the terms of the MPL, indicate your
00030  * decision by deleting the provisions above and replace them with the notice
00031  * and other provisions required by the GPL or the LGPL. If you do not delete
00032  * the provisions above, a recipient may use your version of this file under
00033  * the terms of any one of the MPL, the GPL or the LGPL.
00034  *
00035  * ***** END LICENSE BLOCK ***** */
00036 
00037 /* mozIXMLTerminal.idl: primary interface for XMLterm operations (unscriptable)
00038  */
00039 
00040 #include "nsISupports.idl"
00041 #include "mozILineTerm.idl"
00042 #include "mozIXMLTermShell.idl"
00043 
00044 interface nsISelectionController;
00045 interface nsIDocShell;
00046 interface nsIPresShell;
00047 
00048 %{C++
00049 #define MOZXMLTERMINAL_CLASSNAME  "XMLTerminal Component"
00050 #define MOZXMLTERMINAL_CONTRACTID "@mozilla.org/xmlterm/xmlterminal;1"
00051 
00052 #define MOZXMLTERMINAL_CID                       \
00053 { /* 0eb82b21-43a2-11d3-8e76-006008948af5 */ \
00054    0x0eb82b21, 0x43a2, 0x11d3,               \
00055 {0x8e, 0x76, 0x00, 0x60, 0x08, 0x94, 0x8a, 0xf5} }
00056 %}
00057 
00058 /* NOT SCRIPTABLE */
00059 [uuid(0eb82b20-43a2-11d3-8e76-006008948af5)]
00060 
00061 interface mozIXMLTerminal : nsISupports
00062 {
00071   void init(in nsIDocShell aDocShell,
00072             in mozIXMLTermShell aXMLTermShell,
00073             in wstring aURL,
00074             in wstring args);
00075 
00078   void finalize();
00079 
00082   void poll();
00083 
00086   readonly attribute long currentEntryNumber;
00087 
00090   attribute long history;
00091 
00094   attribute wstring prompt;
00095 
00098   attribute boolean keyIgnore;
00099 
00103   void sendTextAux(in wstring aString);
00104 
00109   void sendText(in wstring aString, in wstring aCookie);
00110 
00113   void paste();
00114 
00117   readonly attribute nsIDOMDocument document;
00118 
00121   readonly attribute nsIDocShell docShell;
00122 
00125   readonly attribute nsIPresShell presShell;
00126 
00129   readonly attribute nsIDOMDocument DOMDocument;
00130 
00133   readonly attribute nsISelectionController selectionController;
00134 
00138   readonly attribute boolean screenMode;
00139 
00144   boolean matchesCookie(in wstring aCookie);
00145 
00148   void resize();
00149 
00155   boolean exportHTML(in wstring aFilename, in long permissions,
00156                      in wstring style, in unsigned long refreshSeconds,
00157                      in boolean forceRefresh);
00158 
00161   void showCaret();
00162 
00169   void screenSize(out long rows, out long cols,
00170                   out long xPixels, out long yPixels);
00171 };
00172 
00173 /* mozIXMLTermSuspend: interface to suspend/resume select XMLterm operations
00174  */
00175 
00176 /* NOT SCRIPTABLE */
00177 [uuid(0eb82b50-43a2-11d3-8e76-006008948af5)]
00178 
00179 interface mozIXMLTermSuspend : nsISupports
00180 {
00181   attribute boolean suspend;
00182 };