xpcom/components/nsIComponentManager.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 /**
  39  * The nsIComponentManager interface.
  40  * @status FROZEN
  41  */
  42
  43 #include "nsISupports.idl"
  44
  45 interface nsIFactory;
  46
  47 [scriptable, uuid(a88e5a60-205a-4bb1-94e1-2628daf51eae)]
  48 interface nsIComponentManager : nsISupports
  49 {
  50     /**
  51      * getClassObject
  52      *
  53      * Returns the factory object that can be used to create instances of
  54      * CID aClass
  55      *
  56      * @param aClass The classid of the factory that is being requested
  57      */
  58     void getClassObject(in nsCIDRef aClass,
  59                         in nsIIDRef aIID,
  60                         [iid_is(aIID),retval] out nsQIResult result);
  61
  62     /**
  63      * getClassObjectByContractID
  64      *
  65      * Returns the factory object that can be used to create instances of
  66      * CID aClass
  67      *
  68      * @param aClass The classid of the factory that is being requested
  69      */
  70     void getClassObjectByContractID(in string aContractID,
  71                                     in nsIIDRef aIID,
  72                                     [iid_is(aIID),retval] out nsQIResult result);
  73
  74
  75    /**
  76      * createInstance
  77      *
  78      * Create an instance of the CID aClass and return the interface aIID.
  79      *
  80      * @param aClass : ClassID of object instance requested
  81      * @param aDelegate : Used for aggregation
  82      * @param aIID : IID of interface requested
  83      */
  84     void createInstance(in nsCIDRef aClass,
  85                         in nsISupports aDelegate,
  86                         in nsIIDRef aIID,
  87                         [iid_is(aIID),retval] out nsQIResult result);
  88
  89     /**
  90      * createInstanceByContractID
  91      *
  92      * Create an instance of the CID that implements aContractID and return the
  93      * interface aIID.
  94      *
  95      * @param aContractID : aContractID of object instance requested
  96      * @param aDelegate : Used for aggregation
  97      * @param aIID : IID of interface requested
  98      */
  99     void createInstanceByContractID(in string aContractID,
 100                                     in nsISupports aDelegate,
 101                                     in nsIIDRef aIID,
 102                                     [iid_is(aIID),retval] out nsQIResult result);
 103 };
 104
 105
 106 %{ C++
 107 #ifdef MOZILLA_INTERNAL_API
 108 #include "nsComponentManagerUtils.h"
 109 #endif
 110 %} C++