| /* -*- Mode: C++; tab-width: 2; 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 "nsIFile.idl" |
| |
| /** |
| * nsIDirectoryServiceProvider |
| * |
| * Used by Directory Service to get file locations. |
| * |
| * @status FROZEN |
| */ |
| |
| [scriptable, uuid(bbf8cab0-d43a-11d3-8cc2-00609792278c)] |
| interface nsIDirectoryServiceProvider: nsISupports |
| { |
| /** |
| * getFile |
| * |
| * Directory Service calls this when it gets the first request for |
| * a prop or on every request if the prop is not persistent. |
| * |
| * @param prop The symbolic name of the file. |
| * @param persistent TRUE - The returned file will be cached by Directory |
| * Service. Subsequent requests for this prop will |
| * bypass the provider and use the cache. |
| * FALSE - The provider will be asked for this prop |
| * each time it is requested. |
| * |
| * @return The file represented by the property. |
| * |
| */ |
| nsIFile getFile(in string prop, out PRBool persistent); |
| }; |
| |
| /** |
| * nsIDirectoryServiceProvider2 |
| * |
| * An extension of nsIDirectoryServiceProvider which allows |
| * multiple files to be returned for the given key. |
| * |
| * @status FROZEN |
| */ |
| |
| [scriptable, uuid(2f977d4b-5485-11d4-87e2-0010a4e75ef2)] |
| interface nsIDirectoryServiceProvider2: nsIDirectoryServiceProvider |
| { |
| /** |
| * getFiles |
| * |
| * Directory Service calls this when it gets a request for |
| * a prop and the requested type is nsISimpleEnumerator. |
| * |
| * @param prop The symbolic name of the file list. |
| * |
| * @return An enumerator for a list of file locations. |
| * The elements in the enumeration are nsIFile |
| * @returnCode NS_SUCCESS_AGGREGATE_RESULT if this result should be |
| * aggregated with other "lower" providers. |
| */ |
| nsISimpleEnumerator getFiles(in string prop); |
| }; |
| |
| /** |
| * nsIDirectoryService |
| * |
| * @status FROZEN |
| */ |
| |
| [scriptable, uuid(57a66a60-d43a-11d3-8cc2-00609792278c)] |
| interface nsIDirectoryService: nsISupports |
| { |
| /** |
| * init |
| * |
| * Must be called. Used internally by XPCOM initialization. |
| * |
| */ |
| void init(); |
| |
| /** |
| * registerProvider |
| * |
| * Register a provider with the service. |
| * |
| * @param prov The service will keep a strong reference |
| * to this object. It will be released when |
| * the service is released. |
| * |
| */ |
| void registerProvider(in nsIDirectoryServiceProvider prov); |
| |
| /** |
| * unregisterProvider |
| * |
| * Unregister a provider with the service. |
| * |
| * @param prov |
| * |
| */ |
| void unregisterProvider(in nsIDirectoryServiceProvider prov); |
| }; |
| |
| |