source: vbox/trunk/src/libs/xpcom18a4/xpcom/components/nsIComponentLoader.idl@ 31232

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is mozilla.org Code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"
#include "nsIFactory.idl"
#include "nsIFile.idl"
#include "nsIComponentManager.idl"

[object, uuid(c073cfc0-567c-11d3-aec1-0000f8e25c06)]
interface nsIComponentLoader : nsISupports {

    /**
     * Get the factory for a given component.
     */
    nsIFactory getFactory(in nsIIDRef aCID, in string aLocation,
                          in string aType);

    /**
     * Initialize the loader.
     *
     * We use nsISupports here because nsIRegistry isn't IDLized yet.
     */
    void init(in nsIComponentManager aCompMgr, in nsISupports aRegistry);
    
    /**
     * Called when a component of the appropriate type is registered,
     * to give the component loader an opportunity to do things like
     * annotate the registry and such.
     */
    void onRegister(in nsIIDRef aCID, in string aType,
                    in string aClassName, in string aContractID,
                    in string aLocation, in boolean aReplace,
                    in boolean aPersist);

    /**
     * When is AutoRegistration occuring?
     */
    const long Startup = 0;
    const long Component = 1;
    const long Timer = 2;

    /**
     * AutoRegister components in the given directory.
     */
    void autoRegisterComponents(in long aWhen, in nsIFile aDirectory);

    /**
     * AutoRegister the given component.
     *
     * Returns true if the component was registered, false if it couldn't
     * attempt to register the component (wrong type) and ``throws'' an
     * NS_FAILED code if there was an error during registration.
     */
    boolean autoRegisterComponent(in long aWhen, in nsIFile aComponent);

    /**
     * AutoUnregister the given component.
     * Returns true if the component was unregistered, false if it coudln't
     * attempt to unregister the component (not found, wrong type).
     */
    boolean autoUnregisterComponent(in long aWhen, in nsIFile aComponent);

    /**
     * Register any deferred (NS_ERROR_FACTORY_REGISTER_AGAIN) components.
     * Return registered-any-components?
     */
    boolean registerDeferredComponents(in long aWhen);

    /**
     * Unload all components that are willing.
     */
    void unloadAll(in long aWhen);
    
};