2012-05-21 11:12:37 +00:00
|
|
|
/* 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/. */
|
|
|
|
|
2006-03-29 18:29:03 +00:00
|
|
|
/*
|
|
|
|
* interface for rendering objects whose state is saved in
|
|
|
|
* session-history (back-forward navigation)
|
|
|
|
*/
|
|
|
|
|
1999-08-30 22:38:58 +00:00
|
|
|
#ifndef _nsIStatefulFrame_h
|
|
|
|
#define _nsIStatefulFrame_h
|
|
|
|
|
2009-01-12 19:20:59 +00:00
|
|
|
#include "nsQueryFrame.h"
|
1999-08-30 22:38:58 +00:00
|
|
|
|
2005-01-27 22:52:53 +00:00
|
|
|
class nsPresState;
|
1999-08-30 22:38:58 +00:00
|
|
|
|
2009-01-12 19:20:59 +00:00
|
|
|
class nsIStatefulFrame
|
|
|
|
{
|
1999-08-30 22:38:58 +00:00
|
|
|
public:
|
2009-09-12 16:49:24 +00:00
|
|
|
NS_DECL_QUERYFRAME_TARGET(nsIStatefulFrame)
|
1999-08-30 22:38:58 +00:00
|
|
|
|
2000-06-14 23:37:06 +00:00
|
|
|
// If you create a special type stateful frame (e.g. scroll) that needs
|
|
|
|
// to be captured outside of the standard pass through the frames, you'll need
|
|
|
|
// a special ID by which to refer to that type.
|
|
|
|
enum SpecialStateID {eNoID=0, eDocumentScrollState};
|
|
|
|
|
2005-12-06 23:56:17 +00:00
|
|
|
// Save the state for this frame. Some implementations may choose to return
|
|
|
|
// different states depending on the value of aStateID. If this method
|
|
|
|
// succeeds, the caller is responsible for deleting the resulting state when
|
|
|
|
// done with it.
|
|
|
|
NS_IMETHOD SaveState(SpecialStateID aStateID, nsPresState** aState) = 0;
|
|
|
|
|
|
|
|
// Restore the state for this frame from aState
|
|
|
|
NS_IMETHOD RestoreState(nsPresState* aState) = 0;
|
1999-08-30 22:38:58 +00:00
|
|
|
};
|
|
|
|
|
1999-08-31 04:20:22 +00:00
|
|
|
#endif /* _nsIStatefulFrame_h */
|