profile/public/nsIProfile.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) 1998
  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 of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or 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 #include "nsIFile.idl"
  40
  41 %{C++
  42
  43 #define NS_PROFILE_CID                                 \
  44   { /* {02b0625b-e7f3-11d2-9f5a-006008a6efe9} */       \
  45     0x02b0625b,                                        \
  46     0xe7f3,                                            \
  47     0x11d2,                                            \
  48     { 0x9f, 0x5a, 0x00, 0x60, 0x08, 0xa6, 0xef, 0xe9 } \
  49   }
  50
  51 #define NS_PROFILE_CONTRACTID   \
  52         "@mozilla.org/profile/manager;1"
  53
  54 #define NS_PROFILE_STARTUP_CATEGORY \
  55         "profile-startup-category"
  56 %}
  57
  58 /**
  59  * nsIProfile
  60  *
  61  * @status FROZEN
  62  * @version 1.0
  63  */
  64
  65 [scriptable, uuid(02b0625a-e7f3-11d2-9f5a-006008a6efe9)]
  66 interface nsIProfile : nsISupports {
  67
  68     readonly attribute long profileCount;
  69     void getProfileList(out unsigned long length, [retval, array, size_is(length)] out wstring profileNames);
  70     boolean profileExists(in wstring profileName);
  71
  72     attribute wstring currentProfile;
  73
  74     const unsigned long SHUTDOWN_PERSIST      = 0x00000001;
  75     const unsigned long SHUTDOWN_CLEANSE      = 0x00000002;
  76
  77     void shutDownCurrentProfile(in unsigned long shutDownType);
  78
  79     void createNewProfile(in wstring profileName,
  80                           in wstring nativeProfileDir,
  81                           in wstring langcode,
  82                           in boolean useExistingDir);
  83
  84     void renameProfile(in wstring oldName, in wstring newName);
  85     void deleteProfile(in wstring name, in boolean canDeleteFiles);
  86     void cloneProfile(in wstring profileName);
  87 };