xpcom/components/nsIComponentManager.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 /**
   7  * The nsIComponentManager interface.
   8  */
   9
  10 #include "nsISupports.idl"
  11
  12 interface nsIFile;
  13 interface nsIFactory;
  14
  15 [scriptable, uuid(1d940426-5fe5-42c3-84ae-a300f2d9ebd5)]
  16 interface nsIComponentManager : nsISupports
  17 {
  18     /**
  19      * getClassObject
  20      *
  21      * Returns the factory object that can be used to create instances of
  22      * CID aClass
  23      *
  24      * @param aClass The classid of the factory that is being requested
  25      */
  26     void getClassObject(in nsCIDRef aClass,
  27                         in nsIIDRef aIID,
  28                         [iid_is(aIID),retval] out nsQIResult result);
  29
  30     /**
  31      * getClassObjectByContractID
  32      *
  33      * Returns the factory object that can be used to create instances of
  34      * CID aClass
  35      *
  36      * @param aClass The classid of the factory that is being requested
  37      */
  38     void getClassObjectByContractID(in string aContractID,
  39                                     in nsIIDRef aIID,
  40                                     [iid_is(aIID),retval] out nsQIResult result);
  41
  42
  43    /**
  44      * createInstance
  45      *
  46      * Create an instance of the CID aClass and return the interface aIID.
  47      *
  48      * @param aClass : ClassID of object instance requested
  49      * @param aDelegate : Used for aggregation
  50      * @param aIID : IID of interface requested
  51      */
  52     void createInstance(in nsCIDRef aClass,
  53                         in nsISupports aDelegate,
  54                         in nsIIDRef aIID,
  55                         [iid_is(aIID),retval] out nsQIResult result);
  56
  57     /**
  58      * createInstanceByContractID
  59      *
  60      * Create an instance of the CID that implements aContractID and return the
  61      * interface aIID.
  62      *
  63      * @param aContractID : aContractID of object instance requested
  64      * @param aDelegate : Used for aggregation
  65      * @param aIID : IID of interface requested
  66      */
  67     void createInstanceByContractID(in string aContractID,
  68                                     in nsISupports aDelegate,
  69                                     in nsIIDRef aIID,
  70                                     [iid_is(aIID),retval] out nsQIResult result);
  71
  72     /**
  73      * addBootstrappedManifestLocation
  74      *
  75      * Adds a bootstrapped manifest location on runtime.
  76      *
  77      * @param aLocation : A directory where chrome.manifest resides,
  78      *                    or an XPI with it on the root.
  79      */
  80     void addBootstrappedManifestLocation(in nsIFile aLocation);
  81
  82     /**
  83      * removeBootstrappedManifestLocation
  84      *
  85      * Removes a bootstrapped manifest location on runtime.
  86      *
  87      * @param aLocation : A directory where chrome.manifest resides,
  88      *                    or an XPI with it on the root.
  89      */
  90     void removeBootstrappedManifestLocation(in nsIFile aLocation);
  91
  92 };
  93
  94
  95 %{ C++
  96 #ifdef MOZILLA_INTERNAL_API
  97 #include "nsComponentManagerUtils.h"
  98 #endif
  99 %} C++