nsIModule.idl
上传用户:goldcmy89
上传日期:2017-12-03
资源大小:2246k
文件大小:4k
源码类别:

PlugIns编程

开发平台:

Visual C++

  1. /* -*- Mode: C++; 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. #include "nsISupports.idl"
  38. interface nsIFile;
  39. interface nsIComponentManager;
  40. /**
  41.  * The nsIModule interface.
  42.  * @status FROZEN
  43.  */
  44. [scriptable, uuid(7392D032-5371-11d3-994E-00805FD26FEE)]
  45. interface nsIModule : nsISupports
  46. {
  47.     /** 
  48.      * Object Instance Creation
  49.      *
  50.      * Obtains a Class Object from a nsIModule for a given CID and IID pair.  
  51.      * This class object can either be query to a nsIFactory or a may be 
  52.      * query to a nsIClassInfo.
  53.      *
  54.      * @param aCompMgr  : The global component manager
  55.      * @param aClass    : ClassID of object instance requested
  56.      * @param aIID      : IID of interface requested
  57.      * 
  58.      */
  59.     void getClassObject(in nsIComponentManager aCompMgr, 
  60.                         in nsCIDRef aClass,
  61.                         in nsIIDRef aIID,
  62.                         [retval, iid_is(aIID)] out nsQIResult aResult);
  63.     /**
  64.      * One time registration callback
  65.      *
  66.      * When the nsIModule is discovered, this method will be
  67.      * called so that any setup registration can be preformed.
  68.      *
  69.      * @param aCompMgr  : The global component manager
  70.      * @param aLocation : The location of the nsIModule on disk
  71.      * @param aLoaderStr: Opaque loader specific string
  72.      * @param aType     : Loader Type being used to load this module 
  73.      */
  74.     void registerSelf(in nsIComponentManager aCompMgr, 
  75.                       in nsIFile aLocation,
  76.                       in string aLoaderStr, 
  77.                       in string aType);
  78.     /**
  79.      * One time unregistration callback
  80.      *
  81.      * When the nsIModule is being unregistered, this method will be
  82.      * called so that any unregistration can be preformed
  83.      *
  84.      * @param aCompMgr   : The global component manager
  85.      * @param aLocation  : The location of the nsIModule on disk
  86.      * @param aLoaderStr : Opaque loader specific string
  87.      * 
  88.      */
  89.    void unregisterSelf(in nsIComponentManager aCompMgr, 
  90.                         in nsIFile aLocation,
  91.                         in string  aLoaderStr);
  92.    /** 
  93.     * Module load management
  94.     * 
  95.     * @param aCompMgr  : The global component manager
  96.     *
  97.     * @return indicates to the caller if the module can be unloaded.
  98.     *  Returning PR_TRUE isn't a guarantee that the module will be
  99.     * unloaded. It constitues only willingness of the module to be
  100.     * unloaded.  It is very important to ensure that no outstanding 
  101.     *       references to the module's code/data exist before returning 
  102.     *       PR_TRUE. 
  103.     * Returning PR_FALSE guaratees that the module wont be unloaded.
  104.     */
  105.     boolean canUnload(in nsIComponentManager aCompMgr);
  106. };