| 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 | #include "nsISupports.idl"
|
|---|
| 39 |
|
|---|
| 40 | /**
|
|---|
| 41 | * A class factory allows the creation of nsISupports derived
|
|---|
| 42 | * components without specifying a concrete base class.
|
|---|
| 43 | *
|
|---|
| 44 | * @status FROZEN
|
|---|
| 45 | */
|
|---|
| 46 |
|
|---|
| 47 | [scriptable, object, uuid(00000001-0000-0000-c000-000000000046)]
|
|---|
| 48 | interface nsIFactory : nsISupports {
|
|---|
| 49 | /**
|
|---|
| 50 | * Creates an instance of a component.
|
|---|
| 51 | *
|
|---|
| 52 | * @param aOuter Pointer to a component that wishes to be aggregated
|
|---|
| 53 | * in the resulting instance. This will be nsnull if no
|
|---|
| 54 | * aggregation is requested.
|
|---|
| 55 | * @param iid The IID of the interface being requested in
|
|---|
| 56 | * the component which is being currently created.
|
|---|
| 57 | * @param result [out] Pointer to the newly created instance, if successful.
|
|---|
| 58 | * @return NS_OK - Component successfully created and the interface
|
|---|
| 59 | * being requested was successfully returned in result.
|
|---|
| 60 | * NS_NOINTERFACE - Interface not accessible.
|
|---|
| 61 | * NS_ERROR_NO_AGGREGATION - if an 'outer' object is supplied, but the
|
|---|
| 62 | * component is not aggregatable.
|
|---|
| 63 | * NS_ERROR* - Method failure.
|
|---|
| 64 | */
|
|---|
| 65 | void createInstance(in nsISupports aOuter, in nsIIDRef iid,
|
|---|
| 66 | [retval, iid_is(iid)] out nsQIResult result);
|
|---|
| 67 |
|
|---|
| 68 | /**
|
|---|
| 69 | * LockFactory provides the client a way to keep the component
|
|---|
| 70 | * in memory until it is finished with it. The client can call
|
|---|
| 71 | * LockFactory(PR_TRUE) to lock the factory and LockFactory(PR_FALSE)
|
|---|
| 72 | * to release the factory.
|
|---|
| 73 | *
|
|---|
| 74 | * @param lock - Must be PR_TRUE or PR_FALSE
|
|---|
| 75 | * @return NS_OK - If the lock operation was successful.
|
|---|
| 76 | * NS_ERROR* - Method failure.
|
|---|
| 77 | */
|
|---|
| 78 | void lockFactory(in PRBool lock);
|
|---|
| 79 | };
|
|---|
