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 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 : * Pierre Phaneuf <pp@ludusdesign.com>
24 : *
25 : * Alternatively, the contents of this file may be used under the terms of
26 : * either of the GNU General Public License Version 2 or later (the "GPL"),
27 : * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 : * in which case the provisions of the GPL or the LGPL are applicable instead
29 : * of those above. If you wish to allow use of your version of this file only
30 : * under the terms of either the GPL or the LGPL, and not to allow others to
31 : * use your version of this file under the terms of the MPL, indicate your
32 : * decision by deleting the provisions above and replace them with the notice
33 : * and other provisions required by the GPL or the LGPL. If you do not delete
34 : * the provisions above, a recipient may use your version of this file under
35 : * the terms of any one of the MPL, the GPL or the LGPL.
36 : *
37 : * ***** END LICENSE BLOCK ***** */
38 :
39 : /*
40 : * interface for container for information saved in session history when
41 : * the document is not
42 : */
43 :
44 : #ifndef _nsILayoutHistoryState_h
45 : #define _nsILayoutHistoryState_h
46 :
47 : #include "nsISupports.h"
48 : #include "nsStringFwd.h"
49 :
50 : class nsPresState;
51 :
52 : #define NS_ILAYOUTHISTORYSTATE_IID \
53 : { 0x003919e2, 0x5e6b, 0x4d76, \
54 : { 0xa9, 0x4f, 0xbc, 0x5d, 0x15, 0x5b, 0x1c, 0x67 } }
55 :
56 0 : class nsILayoutHistoryState : public nsISupports {
57 : public:
58 : NS_DECLARE_STATIC_IID_ACCESSOR(NS_ILAYOUTHISTORYSTATE_IID)
59 :
60 : /**
61 : * Set |aState| as the state object for |aKey|.
62 : * This _transfers_ownership_ of |aState| to the LayoutHistoryState.
63 : * It will be freed when RemoveState() is called or when the
64 : * LayoutHistoryState is destroyed.
65 : */
66 : NS_IMETHOD AddState(const nsCString& aKey, nsPresState* aState) = 0;
67 :
68 : /**
69 : * Look up the state object for |aKey|.
70 : */
71 : NS_IMETHOD GetState(const nsCString& aKey, nsPresState** aState) = 0;
72 :
73 : /**
74 : * Remove the state object for |aKey|.
75 : */
76 : NS_IMETHOD RemoveState(const nsCString& aKey) = 0;
77 :
78 : /**
79 : * Check whether this history has any states in it
80 : */
81 : NS_IMETHOD_(bool) HasStates() const = 0;
82 :
83 : /**
84 : * Sets whether this history can contain only scroll position history
85 : * or all possible history
86 : */
87 : NS_IMETHOD SetScrollPositionOnly(const bool aFlag) = 0;
88 : };
89 :
90 : NS_DEFINE_STATIC_IID_ACCESSOR(nsILayoutHistoryState,
91 : NS_ILAYOUTHISTORYSTATE_IID)
92 :
93 : nsresult
94 : NS_NewLayoutHistoryState(nsILayoutHistoryState** aState);
95 :
96 : #endif /* _nsILayoutHistoryState_h */
97 :
|