author Ben Hearsum <>
Fri, 29 Aug 2008 09:25:45 -0400
changeset 18523 9eea398698242da00fe7f562d9cc62e920e9cb02
parent 3727 638e3d4c61ab20bfa40506d1856cf5c0e82af579
child 22262 4047bed537d67f61567d6fa546da47cdab3dda35
permissions -rw-r--r--
Added tag FIREFOX_3_1a2_RELEASE for changeset f197b51bbc29

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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
 * 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 code.
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 * Contributor(s):
 *   Pierre Phaneuf <>
 * Alternatively, the contents of this file may be used under the terms of
 * either of 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 ***** */

 * interface for container for information saved in session history when
 * the document is not

#ifndef _nsILayoutHistoryState_h
#define _nsILayoutHistoryState_h

#include "nsISupports.h"
#include "nsStringFwd.h"

class nsPresState;

{ 0x99003f0f, 0x7ade, 0x44a1, \
 { 0x81, 0x74, 0xe3, 0x6a, 0xa5, 0xbb, 0x6b, 0x10 } }

class nsILayoutHistoryState : public nsISupports {

   * Set |aState| as the state object for |aKey|.
   * This _transfers_ownership_ of |aState| to the LayoutHistoryState.
   * It will be freed when RemoveState() is called or when the
   * LayoutHistoryState is destroyed.
  NS_IMETHOD AddState(const nsCString& aKey, nsPresState* aState) = 0;

   * Look up the state object for |aKey|.
  NS_IMETHOD GetState(const nsCString& aKey, nsPresState** aState) = 0;

   * Remove the state object for |aKey|.
  NS_IMETHOD RemoveState(const nsCString& aKey) = 0;

   * Check whether this history has any states in it
  NS_IMETHOD_(PRBool) HasStates() const = 0;


NS_NewLayoutHistoryState(nsILayoutHistoryState** aState);

#endif /* _nsILayoutHistoryState_h */