text: /* -*- Mode: C++; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   * ***** BEGIN LICENSE BLOCK *****
   * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   *
   * The contents of this file are subject to the Mozilla Public License Version
   * 1.1 (the "License"); you may not use this file except in compliance with
   * the License. You may obtain a copy of the License at
   * http://www.mozilla.org/MPL/
   *
   * Software distributed under the License is distributed on an "AS IS" basis,
   * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
   * for the specific language governing rights and limitations under the
   * License.
   *
   * The Original Code is Mozilla Corporation code.
   *
   * The Initial Developer of the Original Code is Mozilla Foundation.
   * Portions created by the Initial Developer are Copyright (C) 2010
   * the Initial Developer. All Rights Reserved.
   *
   * Contributor(s):
   *   Robert O'Callahan <robert@ocallahan.org>
   *
   * Alternatively, the contents of this file may be used under the terms of
   * either the GNU General Public License Version 2 or later (the "GPL"), or
   * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
   * in which case the provisions of the GPL or the LGPL are applicable instead
   * of those above. If you wish to allow use of your version of this file only
   * under the terms of either the GPL or the LGPL, and not to allow others to
   * use your version of this file under the terms of the MPL, indicate your
   * decision by deleting the provisions above and replace them with the notice
   * and other provisions required by the GPL or the LGPL. If you do not delete
   * the provisions above, a recipient may use your version of this file under
   * the terms of any one of the MPL, the GPL or the LGPL.
   *
   * ***** END LICENSE BLOCK ***** */
  
  #ifndef NSSUBDOCUMENTFRAME_H_
  #define NSSUBDOCUMENTFRAME_H_
  
  #include "nsLeafFrame.h"
  #include "nsIReflowCallback.h"
  #include "nsFrameLoader.h"
  
  /******************************************************************************
   * nsSubDocumentFrame
   *****************************************************************************/
  class nsSubDocumentFrame : public nsLeafFrame,
                             public nsIReflowCallback
  {
  public:
    NS_DECL_QUERYFRAME_TARGET(nsSubDocumentFrame)
    NS_DECL_FRAMEARENA_HELPERS
  
    nsSubDocumentFrame(nsStyleContext* aContext);
  
  #ifdef DEBUG
    NS_IMETHOD GetFrameName(nsAString& aResult) const;
  #endif
  
    NS_DECL_QUERYFRAME
  
    virtual nsIAtom* GetType() const;
  
    virtual PRBool IsFrameOfType(PRUint32 aFlags) const
    {
      // nsLeafFrame is already eReplacedContainsBlock, but that's somewhat bogus
      return nsLeafFrame::IsFrameOfType(aFlags &
        ~(nsIFrame::eReplaced | nsIFrame::eReplacedContainsBlock));
    }
  
    NS_IMETHOD Init(nsIContent*      aContent,
                    nsIFrame*        aParent,
                    nsIFrame*        aPrevInFlow);
  
    virtual void DestroyFrom(nsIFrame* aDestructRoot);
  
    virtual nscoord GetMinWidth(nsRenderingContext *aRenderingContext);
    virtual nscoord GetPrefWidth(nsRenderingContext *aRenderingContext);
  
    virtual IntrinsicSize GetIntrinsicSize();
    virtual nsSize  GetIntrinsicRatio();
  
    virtual nsSize ComputeAutoSize(nsRenderingContext *aRenderingContext,
                                   nsSize aCBSize, nscoord aAvailableWidth,
                                   nsSize aMargin, nsSize aBorder,
                                   nsSize aPadding, PRBool aShrinkWrap);
  
    virtual nsSize ComputeSize(nsRenderingContext *aRenderingContext,
                               nsSize aCBSize, nscoord aAvailableWidth,
                               nsSize aMargin, nsSize aBorder, nsSize aPadding,
                               PRBool aShrinkWrap);
  
    NS_IMETHOD Reflow(nsPresContext*          aPresContext,
                      nsHTMLReflowMetrics&     aDesiredSize,
                      const nsHTMLReflowState& aReflowState,
                      nsReflowStatus&          aStatus);
  
    NS_IMETHOD BuildDisplayList(nsDisplayListBuilder*   aBuilder,
                                const nsRect&           aDirtyRect,
                                const nsDisplayListSet& aLists);
  
    NS_IMETHOD AttributeChanged(PRInt32 aNameSpaceID,
                                nsIAtom* aAttribute,
                                PRInt32 aModType);
  
    // if the content is "visibility:hidden", then just hide the view
    // and all our contents. We don't extend "visibility:hidden" to
    // the child content ourselves, since it belongs to a different
    // document and CSS doesn't inherit in there.
    virtual PRBool SupportsVisibilityHidden() { return PR_FALSE; }
  
  #ifdef ACCESSIBILITY
    virtual already_AddRefed<nsAccessible> CreateAccessible();
  #endif
  
    nsresult GetDocShell(nsIDocShell **aDocShell);
    nsresult BeginSwapDocShells(nsIFrame* aOther);
    void EndSwapDocShells(nsIFrame* aOther);
    nsIView* EnsureInnerView();
    nsIFrame* GetSubdocumentRootFrame();
  
    // nsIReflowCallback
    virtual PRBool ReflowFinished();
    virtual void ReflowCallbackCanceled();
  
  protected:
    friend class AsyncFrameInit;
  
    // Helper method to look up the HTML marginwidth & marginheight attributes
    nsIntSize GetMarginAttributes();
  
    nsFrameLoader* FrameLoader();
  
    PRBool IsInline() { return mIsInline; }
  
    virtual nscoord GetIntrinsicWidth();
    virtual nscoord GetIntrinsicHeight();
  
    virtual PRIntn GetSkipSides() const;
  
    // Hide or show our document viewer
    void HideViewer();
    void ShowViewer();
  
    /* Obtains the frame we should use for intrinsic size information if we are
     * an HTML <object>, <embed> or <applet> (a replaced element - not <iframe>)
     * and our sub-document has an intrinsic size. The frame returned is the
     * frame for the document element of the document we're embedding.
     *
     * Called "Obtain*" and not "Get*" because of comment on GetDocShell that
     * says it should be called ObtainDocShell because of it's side effects.
     */
    nsIFrame* ObtainIntrinsicSizeFrame();
  
    nsRefPtr<nsFrameLoader> mFrameLoader;
    nsIView* mInnerView;
    PRPackedBool mIsInline;
    PRPackedBool mPostedReflowCallback;
    PRPackedBool mDidCreateDoc;
    PRPackedBool mCallingShow;
  };
  
  #endif /* NSSUBDOCUMENTFRAME_H_ */
  