modules/libpref/public/nsIRelativeFilePref.idl

   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) 2002
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Conrad Carlen <ccarlen@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40 interface nsILocalFile;
  41
  42 /**
  43  * The nsIRelativeFilePref interface is a wrapper for an nsILocalFile and
  44  * and a directory service key. When used as a pref value, it stores a
  45  * relative path to the file from the location pointed to by the directory
  46  * service key. The path has the same syntax across all platforms.
  47  *
  48  * @see nsIPrefBranch::getComplexValue
  49  * @see nsIPrefBranch::setComplexValue
  50  *
  51  */
  52
  53 [scriptable, uuid(2f977d4e-5485-11d4-87e2-0010a4e75ef2)]
  54 interface nsIRelativeFilePref : nsISupports
  55 {
  56   /**
  57    * file
  58    *
  59    * The file whose location is stored or retrieved.
  60    */
  61   attribute nsILocalFile file;
  62
  63   /**
  64    * relativeToKey
  65    *
  66    * A directory service key for the directory
  67    * from which the file path is relative.
  68    */
  69   attribute ACString relativeToKey;
  70
  71 };
  72
  73 %{C++
  74
  75 #define NS_RELATIVEFILEPREF_CID                        \
  76   { /* {2f977d4f-5485-11d4-87e2-0010a4e75ef2} */       \
  77     0x2f977d4f,                                        \
  78     0x5485,                                            \
  79     0x11d4,                                            \
  80     { 0x87, 0xe2, 0x00, 0x10, 0xa4, 0xe7, 0x5e, 0xf2 } \
  81   }
  82
  83 #define NS_RELATIVEFILEPREF_CONTRACTID "@mozilla.org/pref-relativefile;1"
  84 #define NS_RELATIVEFILEPREF_CLASSNAME "Relative File Pref"
  85
  86 #include "nsComponentManagerUtils.h"
  87
  88 inline nsresult
  89 NS_NewRelativeFilePref(nsILocalFile* aFile, const nsACString& relativeToKey, nsIRelativeFilePref** result)
  90 {
  91     nsresult rv;
  92     nsCOMPtr<nsIRelativeFilePref> local(do_CreateInstance(NS_RELATIVEFILEPREF_CONTRACTID, &rv));
  93     if (NS_FAILED(rv)) return rv;
  94
  95     (void)local->SetFile(aFile);
  96     (void)local->SetRelativeToKey(relativeToKey);
  97
  98     *result = local;
  99     NS_ADDREF(*result);
 100     return NS_OK;
 101 }
 102
 103 %}