Back to index

lightning-sunbird  0.9+nobinonly
nsIInterfaceInfo.idl
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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) 1999
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 /* The nsIInterfaceInfo public declaration. */
00039 
00040 
00041 #include "nsISupports.idl"
00042 
00043 // forward declaration of non-XPCOM types
00044 
00045 [ptr] native nsXPTMethodInfoPtr(nsXPTMethodInfo);
00046 [ptr] native nsXPTConstantPtr(nsXPTConstant);
00047 [ptr] native nsXPTParamInfoPtr(nsXPTParamInfo);
00048       native nsXPTType(nsXPTType);
00049 
00050 // We bend the rules to do a [shared] nsIID (but this is never scriptable)  
00051 [ptr] native nsIIDPtrShared(nsIID);
00052 
00053 %{C++
00054 class nsXPTMethodInfo;
00055 class nsXPTConstant;
00056 class nsXPTParamInfo;
00057 class nsXPTType;
00058 %}
00059 
00060 /* this is NOT intended to be scriptable */
00061 [uuid(215DBE04-94A7-11d2-BA58-00805F8A5DD7)]
00062 interface nsIInterfaceInfo : nsISupports
00063 {
00064     readonly attribute string   name;
00065     readonly attribute nsIIDPtr InterfaceIID;
00066 
00067     PRBool isScriptable();
00068 
00069     readonly attribute nsIInterfaceInfo parent;
00070 
00074     readonly attribute PRUint16 methodCount;
00075     readonly attribute PRUint16 constantCount;
00076 
00083     void getMethodInfo(in PRUint16 index, 
00084                        [shared, retval] out nsXPTMethodInfoPtr info);
00085 
00086     void getMethodInfoForName(in string methodName, out PRUint16 index, 
00087                        [shared, retval] out nsXPTMethodInfoPtr info);
00088 
00089     void getConstant(in PRUint16 index, 
00090                      [shared, retval] out nsXPTConstantPtr constant);
00091 
00092 
00098     nsIInterfaceInfo getInfoForParam(in PRUint16 methodIndex, 
00099                                      [const] in nsXPTParamInfoPtr param);
00100 
00101     nsIIDPtr getIIDForParam(in PRUint16 methodIndex, 
00102                             [const] in nsXPTParamInfoPtr param);
00103 
00104 
00109     nsXPTType getTypeForParam(in PRUint16 methodIndex, 
00110                               [const] in nsXPTParamInfoPtr param,
00111                               in PRUint16 dimension);
00112 
00113     PRUint8 getSizeIsArgNumberForParam(in PRUint16 methodIndex, 
00114                                        [const] in nsXPTParamInfoPtr param,
00115                                        in PRUint16 dimension);
00116 
00117     PRUint8 getLengthIsArgNumberForParam(in PRUint16 methodIndex, 
00118                                          [const] in nsXPTParamInfoPtr param,
00119                                          in PRUint16 dimension);
00120 
00121     PRUint8 getInterfaceIsArgNumberForParam(in PRUint16 methodIndex, 
00122                                             [const] in nsXPTParamInfoPtr param);
00123 
00124     PRBool isIID(in nsIIDPtr IID);
00125 
00126     void   getNameShared([shared,retval] out string name);
00127     void   getIIDShared([shared,retval] out nsIIDPtrShared iid);
00128 
00129     PRBool isFunction();
00130 
00131     PRBool hasAncestor(in nsIIDPtr iid);
00132 
00133     [notxpcom] nsresult getIIDForParamNoAlloc(in PRUint16 methodIndex, 
00134                                               [const] in nsXPTParamInfoPtr param,
00135                                               out nsIID iid);
00136 };
00137