nsISessionStore.idl

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Mozilla Public License Version
 * 1.1 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
 * for the specific language governing rights and limitations under the
 * License.
 *
 * The Original Code is the Session Restore component.
 *
 * The Initial Developer of the Original Code is
 * Simon Bünzli <zeniko@gmail.com>
 * Portions created by the Initial Developer are Copyright (C) 2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *   Dietrich Ayala <dietrich@mozilla.com>
 *   Michael Kraft <morac99-firefox@yahoo.com>
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsISupports.idl"

interface nsIDOMWindow;
interface nsIDOMNode;

[scriptable, uuid(70592a0d-87d3-459c-8db7-dcb8d47af78e)]
interface nsISessionStore : nsISupports
{
  void init(in nsIDOMWindow aWindow);

  AString getBrowserState();

  void setBrowserState(in AString aState);

  AString getWindowState(in nsIDOMWindow aWindow);

  void setWindowState(in nsIDOMWindow aWindow, in AString aState, in boolean aOverwrite);

  AString getTabState(in nsIDOMNode aTab);

  void setTabState(in nsIDOMNode aTab, in AString aState);

  nsIDOMNode duplicateTab(in nsIDOMWindow aWindow, in nsIDOMNode aTab);

  unsigned long getClosedTabCount(in nsIDOMWindow aWindow);

  AString getClosedTabData(in nsIDOMWindow aWindow);

  nsIDOMNode undoCloseTab(in nsIDOMWindow aWindow, in unsigned long aIndex);

  nsIDOMNode forgetClosedTab(in nsIDOMWindow aWindow, in unsigned long aIndex);

  unsigned long getClosedWindowCount();

  AString getClosedWindowData();

  nsIDOMWindow undoCloseWindow(in unsigned long aIndex);

  nsIDOMNode forgetClosedWindow(in unsigned long aIndex);

  AString getWindowValue(in nsIDOMWindow aWindow, in AString aKey);

  void setWindowValue(in nsIDOMWindow aWindow, in AString aKey, in AString aStringValue);
  
  void deleteWindowValue(in nsIDOMWindow aWindow, in AString aKey);

  AString getTabValue(in nsIDOMNode aTab, in AString aKey);

  void setTabValue(in nsIDOMNode aTab, in AString aKey, in AString aStringValue);

  void deleteTabValue(in nsIDOMNode aTab, in AString aKey);

  void persistTabAttribute(in AString aName);
};