layout/generic/nsIFrameFrame.h

   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  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 /*
  39  * interface for rendering objects for replaced elements containing a
  40  * document, such as <frame>, <iframe>, and some <object>s
  41  */
  42
  43 #ifndef nsIFrameFrame_h___
  44 #define nsIFrameFrame_h___
  45
  46 class nsIDocShell;
  47
  48 class nsIFrameFrame
  49 {
  50 public:
  51   NS_DECLARE_FRAME_ACCESSOR(nsIFrameFrame)
  52
  53   NS_IMETHOD GetDocShell(nsIDocShell **aDocShell) = 0;
  54
  55   /**
  56    * Only allowed to fail if the other frame is not the same type as
  57    * this one or if one of the frames has no docshell.  Don't call
  58    * EndSwapDocShells() unless BeginSwapDocShells() succeeds.
  59    */
  60   NS_IMETHOD BeginSwapDocShells(nsIFrame* aOther) = 0;
  61   virtual void EndSwapDocShells(nsIFrame* aOther) = 0;
  62 };
  63
  64 #endif