toolkit/profile/public/nsIToolkitProfileService.idl

   1 /* -*- Mode: IDL; tab-width: 8; 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 the new Mozilla toolkit.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Benjamin Smedberg <bsmedberg@covad.net>
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  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 the GNU General Public License Version 2 or later (the "GPL"), or
  26  * 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 interface nsISimpleEnumerator;
  41 interface nsILocalFile;
  42 interface nsIToolkitProfile;
  43 interface nsIProfileLock;
  44
  45 [scriptable, uuid(9b434f48-438c-4f85-89de-b7f321a45341)]
  46 interface nsIToolkitProfileService : nsISupports
  47 {
  48     attribute boolean startWithLastProfile;
  49     attribute boolean startOffline;
  50
  51     readonly attribute nsISimpleEnumerator /*nsIToolkitProfile*/ profiles;
  52
  53     attribute nsIToolkitProfile selectedProfile;
  54
  55     /**
  56      * Get a profile by name. This is mainly for use by the -P
  57      * commandline flag.
  58      *
  59      * @param aName The profile name to find.
  60      */
  61     nsIToolkitProfile getProfileByName(in AUTF8String aName);
  62
  63     /**
  64      * Lock an arbitrary path as a profile. If the path does not exist, it
  65      * will be created and the defaults copied from the application directory.
  66      */
  67     nsIProfileLock lockProfilePath(in nsILocalFile aDirectory,
  68                                    in nsILocalFile aTempDirectory);
  69
  70     /**
  71      * Create a new profile.
  72      *
  73      * @param aRootDir
  74      *        The profile directory. May be null, in which case a suitable
  75      *        default will be chosen based on the profile name.
  76      * @param aTempDir
  77      *        The profile temporary directory. May be null, in which case a
  78      *        suitable default will be chosen based either on the profile name
  79      *        if aRootDir is null or aRootDir itself.
  80      * @param aName
  81      *        The profile name.
  82      */
  83     nsIToolkitProfile createProfile(in nsILocalFile aRootDir,
  84                                     in nsILocalFile aTempDir,
  85                                     in AUTF8String aName);
  86
  87     /**
  88      * Returns the number of profiles.
  89      * @return 0, 1, or 2. More than 2 profiles will always return 2.
  90      */
  91     readonly attribute unsigned long profileCount;
  92
  93     /**
  94      * Flush the profiles list file.
  95      */
  96     void flush();
  97 };
  98
  99 %{C++
 100 #define NS_PROFILESERVICE_CONTRACTID "@mozilla.org/toolkit/profile-service;1"
 101 %}