| /* -*- 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) 2002 |
| * the Initial Developer. All Rights Reserved. |
| * |
| * Contributor(s): |
| * Conrad Carlen <ccarlen@netscape.com> |
| * |
| * Alternatively, the contents of this file may be used under the terms of |
| * either 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" |
| interface nsILocalFile; |
| |
| /** |
| * The nsIRelativeFilePref interface is a wrapper for an nsILocalFile and |
| * and a directory service key. When used as a pref value, it stores a |
| * relative path to the file from the location pointed to by the directory |
| * service key. The path has the same syntax across all platforms. |
| * |
| * @see nsIPrefBranch::getComplexValue |
| * @see nsIPrefBranch::setComplexValue |
| * |
| */ |
| |
| [scriptable, uuid(2f977d4e-5485-11d4-87e2-0010a4e75ef2)] |
| interface nsIRelativeFilePref : nsISupports |
| { |
| /** |
| * file |
| * |
| * The file whose location is stored or retrieved. |
| */ |
| attribute nsILocalFile file; |
| |
| /** |
| * relativeToKey |
| * |
| * A directory service key for the directory |
| * from which the file path is relative. |
| */ |
| attribute ACString relativeToKey; |
| |
| }; |
| |
| %{C++ |
| |
| #define NS_RELATIVEFILEPREF_CID \ |
| { /* {2f977d4f-5485-11d4-87e2-0010a4e75ef2} */ \ |
| 0x2f977d4f, \ |
| 0x5485, \ |
| 0x11d4, \ |
| { 0x87, 0xe2, 0x00, 0x10, 0xa4, 0xe7, 0x5e, 0xf2 } \ |
| } |
| |
| #define NS_RELATIVEFILEPREF_CONTRACTID "@mozilla.org/pref-relativefile;1" |
| #define NS_RELATIVEFILEPREF_CLASSNAME "Relative File Pref" |
| |
| #include "nsComponentManagerUtils.h" |
| |
| inline nsresult |
| NS_NewRelativeFilePref(nsILocalFile* aFile, const nsACString& relativeToKey, nsIRelativeFilePref** result) |
| { |
| nsresult rv; |
| nsCOMPtr<nsIRelativeFilePref> local(do_CreateInstance(NS_RELATIVEFILEPREF_CONTRACTID, &rv)); |
| if (NS_FAILED(rv)) return rv; |
| |
| (void)local->SetFile(aFile); |
| (void)local->SetRelativeToKey(relativeToKey); |
| |
| *result = local; |
| NS_ADDREF(*result); |
| return NS_OK; |
| } |
| |
| %} |