browser/components/sessionstore/nsISessionStartup.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is the Session Restore component.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Simon Bünzli <zeniko@gmail.com>
  18  * Portions created by the Initial Developer are Copyright (C) 2006
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Dietrich Ayala <dietrich@mozilla.com>
  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 /**
  41  * nsISessionStore keeps track of the current browsing state - i.e.
  42  * tab history, cookies, scroll state, form data, POSTDATA and window features
  43  * - and allows to restore everything into one window.
  44  */
  45
  46 [scriptable, uuid(c0b185e7-0d21-46ac-8eee-7b5065ee7ecd)]
  47 interface nsISessionStartup: nsISupports
  48 {
  49   // Get session state as string
  50   readonly attribute AString state;
  51
  52   /**
  53    * Determine if session should be restored
  54    */
  55   boolean doRestore();
  56
  57   /**
  58    * What type of session we're restoring. If we have a session, we're
  59    * either restoring state from a crash or restoring state that the user
  60    * requested we save on shutdown.
  61    */
  62   const unsigned long NO_SESSION = 0;
  63   const unsigned long RECOVER_SESSION = 1;
  64   const unsigned long RESUME_SESSION = 2;
  65
  66   readonly attribute unsigned long sessionType;
  67 };