browser/components/migration/public/nsIBrowserProfileMigrator.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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 Browser Profile Migrator.
  16  *
  17  * The Initial Developer of the Original Code is Ben Goodger.
  18  * Portions created by the Initial Developer are Copyright (C) 2004
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "nsISupports.idl"
  38
  39 interface nsISupportsArray;
  40 interface nsIProfileStartup;
  41
  42 [scriptable, uuid(f8365b4a-da55-4e47-be7a-230142360f62)]
  43 interface nsIBrowserProfileMigrator : nsISupports
  44 {
  45   /**
  46    * profile items to migrate. use with migrate().
  47    */
  48   const unsigned short ALL         = 0x0000;
  49   const unsigned short SETTINGS    = 0x0001;
  50   const unsigned short COOKIES     = 0x0002;
  51   const unsigned short HISTORY     = 0x0004;
  52   const unsigned short FORMDATA    = 0x0008;
  53   const unsigned short PASSWORDS   = 0x0010;
  54   const unsigned short BOOKMARKS   = 0x0020;
  55   const unsigned short OTHERDATA   = 0x0040;
  56
  57   /**
  58    * Copy user profile information to the current active profile.
  59    * @param aItems   list of data items to migrate. see above for values.
  60    * @param aStartup helper interface which is non-null if called during startup.
  61    * @param aProfile profile to migrate from, if there is more than one.
  62    */
  63   void migrate(in unsigned short aItems, in nsIProfileStartup aStartup, in wstring aProfile);
  64
  65   /**
  66    * A bit field containing profile items that this migrator
  67    * offers for import.
  68    * @param   aProfile the profile that we are looking for available data
  69    *          to import
  70    * @param   aDoingStartup "true" if the profile is not currently being used.
  71    * @returns bit field containing profile items (see above)
  72    */
  73   unsigned short getMigrateData(in wstring aProfile, in boolean aDoingStartup);
  74
  75   /**
  76    * Whether or not there is any data that can be imported from this
  77    * browser (i.e. whether or not it is installed, and there exists
  78    * a user profile)
  79    */
  80   readonly attribute boolean          sourceExists;
  81
  82   /**
  83    * Whether or not the import source implementing this interface
  84    * has multiple user profiles configured.
  85    */
  86   readonly attribute boolean          sourceHasMultipleProfiles;
  87
  88   /**
  89    * An enumeration of available profiles. If the import source does
  90    * not support profiles, this attribute is null.
  91    */
  92   readonly attribute nsISupportsArray sourceProfiles;
  93
  94   /**
  95    * The import source homepage.  Returns null if not present/available
  96    */
  97   readonly attribute AUTF8String      sourceHomePageURL;
  98 };