gecko-dev/layout/generic/nsIStatefulFrame.h

/* 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 "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;
};

#endif /* _nsIStatefulFrame_h */
Bug 716478 - update licence to MPL 2. 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/. */`

Single line comments to describe files (helpful in LXR) 2006-03-29 18:29:03 +00:00			`/*`
			`* interface for rendering objects whose state is saved in`
			`* session-history (back-forward navigation)`
			`*/`

Added get/set document state API for use by session history. 1999-08-30 22:38:58 +00:00			`#ifndef _nsIStatefulFrame_h`
			`#define _nsIStatefulFrame_h`

Bug 396185 - Make nsIFrame derivatives and helper abstract classes use a different dynamic-cast system than nsISupports: * we know all types frames may be cast to at compile time, so instead of extensible GUID IIDs, use a big enum (see nsQueryFrame::FrameIID) * eliminate all vestiges of refcounting, since frames aren't refcounted Some frames (SVG frames in particular) still implement nsISupports-derived interfaces, for example nsISVGValue. There is a FrameIID for nsISVGValue that lets you go from a frame to the XPCOM interface, but you can't query back. r+sr=roc nsITextControlFrame didn't have an IID the first time around, but this wasn't a compile error because nsITextControlFrame::kFrameIID inherited from nsIFormControlFrame::kFrameIID. I've added a static analysis pass to verify the correct behavior, since I can't figure out a way to make the compiler do it. --HG-- extra : rebase_source : 4894a2ca0278e2ab92f27459db77165f8348cf41 2009-01-12 19:20:59 +00:00			`#include "nsQueryFrame.h"`
Added get/set document state API for use by session history. 1999-08-30 22:38:58 +00:00
Remove nsIPresState (bug 279699). r+sr=roc. 2005-01-27 22:52:53 +00:00			`class nsPresState;`
Added get/set document state API for use by session history. 1999-08-30 22:38:58 +00:00
Bug 396185 - Make nsIFrame derivatives and helper abstract classes use a different dynamic-cast system than nsISupports: * we know all types frames may be cast to at compile time, so instead of extensible GUID IIDs, use a big enum (see nsQueryFrame::FrameIID) * eliminate all vestiges of refcounting, since frames aren't refcounted Some frames (SVG frames in particular) still implement nsISupports-derived interfaces, for example nsISVGValue. There is a FrameIID for nsISVGValue that lets you go from a frame to the XPCOM interface, but you can't query back. r+sr=roc nsITextControlFrame didn't have an IID the first time around, but this wasn't a compile error because nsITextControlFrame::kFrameIID inherited from nsIFormControlFrame::kFrameIID. I've added a static analysis pass to verify the correct behavior, since I can't figure out a way to make the compiler do it. --HG-- extra : rebase_source : 4894a2ca0278e2ab92f27459db77165f8348cf41 2009-01-12 19:20:59 +00:00			`class nsIStatefulFrame`
			`{`
Added get/set document state API for use by session history. 1999-08-30 22:38:58 +00:00			`public:`
Bug 497495 part 3: Add methods to every nsFrame subclass that expose the as-allocated identity of every frame object. Also some cleanups to the QueryFrame implementation. r=dbaron sr=roc 2009-09-12 16:49:24 +00:00			`NS_DECL_QUERYFRAME_TARGET(nsIStatefulFrame)`
Added get/set document state API for use by session history. 1999-08-30 22:38:58 +00:00
Bug 811301. Part 2: Remove saved state IDs now that the root scroll frame state is captured normally. r=mats 2012-11-15 06:40:17 +00:00			`// 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;`
Don't store the "normal" frame state for the root scrollframe, for now. Bug 318709, r+sr=roc 2005-12-06 23:56:17 +00:00
			`// Restore the state for this frame from aState`
			`NS_IMETHOD RestoreState(nsPresState* aState) = 0;`
Added get/set document state API for use by session history. 1999-08-30 22:38:58 +00:00			`};`

Added missing = 0 to make method's pure virtual 1999-08-31 04:20:22 +00:00			`#endif /* _nsIStatefulFrame_h */`