Back to index

lightning-sunbird  0.9+nobinonly
mozILineTerm.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 /* mozILineTerm.idl: Javascript-accessible interface to LineTerm
00038  */
00039 
00040 #include "nsISupports.idl"
00041 #include "nsIObserver.idl"
00042 #include "domstubs.idl"
00043 
00044 %{C++
00045 #include "nsString.h"
00046 class nsIDOMDocument;
00047 
00048 #define MOZLINETERM_CLASSNAME  "LineTerm Component"
00049 #define MOZLINETERM_CONTRACTID "@mozilla.org/xmlterm/lineterm;1"
00050 
00051 #define MOZLINETERM_CID                      \
00052 { /* 0eb82b01-43a2-11d3-8e76-006008948af5 */ \
00053    0x0eb82b01, 0x43a2, 0x11d3,               \
00054 {0x8e, 0x76, 0x00, 0x60, 0x08, 0x94, 0x8a, 0xf5} }
00055 %}
00056 
00057 [scriptable, uuid(0eb82b00-43a2-11d3-8e76-006008948af5)]
00058 
00059 interface mozILineTerm : nsISupports
00060 {
00076   void Open(in wstring command, in wstring initInput, in wstring promptRegexp,
00077             in PRInt32 options, in PRInt32 processType,
00078             in nsIDOMDocument domDoc);
00079 
00083   void Close(in wstring aCookie);
00084 
00089   void Write(in wstring buf, in wstring aCookie);
00090 
00100   wstring Read(out PRInt32 opcodes, out PRInt32 opvals,
00101                out PRInt32 buf_row, out PRInt32 buf_col, in wstring aCookie);
00102 };
00103 
00104 [ref] native nsNativeStringRef(nsString);
00105 
00106 /* NOT SCRIPTABLE */
00107 [uuid(0eb82b10-43a2-11d3-8e76-006008948af5)]
00108 
00109 interface mozILineTermAux : mozILineTerm
00110 {
00111 
00131   void openAux(in wstring command,
00132                in wstring initInput,
00133                in wstring promptRegexp,
00134                in PRInt32 options, in PRInt32 processType,
00135                in PRInt32 nRows, in PRInt32 nCols,
00136                in PRInt32 xPixels, in PRInt32 yPixels,
00137                in nsIDOMDocument domDoc,
00138                in nsIObserver anObserver,
00139                in nsNativeStringRef aCookie);
00140 
00144   void suspendAux(in boolean suspend);
00145 
00148   void closeAux();
00149 
00152   void closeAllAux();
00153 
00158   void resizeAux(in long nRows, in long nCols);
00159 
00170   void readAux(out long opcodes, out long opvals,
00171                out long buf_row, out long buf_col,
00172                out wstring retval, out wstring retstyle);
00173 
00174   void getCookie(in nsNativeStringRef aCookie);
00175 
00176   attribute long cursorRow;
00177   attribute long cursorColumn;
00178   attribute boolean echoFlag;
00179 };
00180