modules/libpref/nsIRelativeFilePref.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #include "nsISupports.idl"
   7 interface nsIFile;
   8
   9 /**
  10  * The nsIRelativeFilePref interface is a wrapper for an nsIFile and
  11  * and a directory service key. When used as a pref value, it stores a
  12  * relative path to the file from the location pointed to by the directory
  13  * service key. The path has the same syntax across all platforms.
  14  *
  15  * @see nsIPrefBranch::getComplexValue
  16  * @see nsIPrefBranch::setComplexValue
  17  *
  18  */
  19
  20 [scriptable, uuid(2f977d4e-5485-11d4-87e2-0010a4e75ef2)]
  21 interface nsIRelativeFilePref : nsISupports
  22 {
  23   /**
  24    * file
  25    *
  26    * The file whose location is stored or retrieved.
  27    */
  28   attribute nsIFile file;
  29
  30   /**
  31    * relativeToKey
  32    *
  33    * A directory service key for the directory
  34    * from which the file path is relative.
  35    */
  36   attribute ACString relativeToKey;
  37
  38 };