summaryrefslogtreecommitdiff
path: root/layout/generic/nsIStatefulFrame.h
diff options
context:
space:
mode:
Diffstat (limited to 'layout/generic/nsIStatefulFrame.h')
-rw-r--r--layout/generic/nsIStatefulFrame.h39
1 files changed, 39 insertions, 0 deletions
diff --git a/layout/generic/nsIStatefulFrame.h b/layout/generic/nsIStatefulFrame.h
new file mode 100644
index 0000000000..9205bb8c96
--- /dev/null
+++ b/layout/generic/nsIStatefulFrame.h
@@ -0,0 +1,39 @@
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+
+/*
+ * interface for rendering objects whose state is saved in
+ * session-history (back-forward navigation)
+ */
+
+#ifndef _nsIStatefulFrame_h
+#define _nsIStatefulFrame_h
+
+#include "nsContentUtils.h"
+#include "nsQueryFrame.h"
+
+class nsPresState;
+
+class nsIStatefulFrame
+{
+ public:
+ NS_DECL_QUERYFRAME_TARGET(nsIStatefulFrame)
+
+ // Save the state for this frame. If this method succeeds, the caller is
+ // responsible for deleting the resulting state when done with it.
+ NS_IMETHOD SaveState(nsPresState** aState) = 0;
+
+ // Restore the state for this frame from aState
+ NS_IMETHOD RestoreState(nsPresState* aState) = 0;
+
+ // Generate a key for this stateful frame
+ NS_IMETHOD GenerateStateKey(nsIContent* aContent,
+ nsIDocument* aDocument,
+ nsACString& aKey)
+ {
+ return nsContentUtils::GenerateStateKey(aContent, aDocument, aKey);
+ };
+};
+
+#endif /* _nsIStatefulFrame_h */