Back to index

lightning-sunbird  0.9+nobinonly
nsHTMLReflowCommand.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 #ifndef nsHTMLReflowCommand_h___
00038 #define nsHTMLReflowCommand_h___
00039 #include "nsReflowType.h"
00040 #include "nsVoidArray.h"
00041 #include <stdio.h>
00042 #include "nsIAtom.h"
00043 
00044 class  nsIFrame;
00045 class  nsPresContext;
00046 class  nsIRenderingContext;
00047 struct nsHTMLReflowMetrics;
00048 struct nsSize;
00049 
00050 // Reflow command flags
00051 #define NS_RC_CREATED_DURING_DOCUMENT_LOAD 0x0001
00052 
00053 
00076 class nsHTMLReflowCommand {
00077 public:
00083   nsHTMLReflowCommand(nsIFrame*    aTargetFrame,
00084                       nsReflowType aReflowType,
00085                       nsIAtom*     aChildListName);
00086 
00087   ~nsHTMLReflowCommand();
00088 
00092   nsIFrame* GetTarget() const { return mTargetFrame; }
00093 
00097   nsReflowType Type() const { return mType; }
00098 
00107   nsIAtom* GetChildListName() const { return mListName; }
00108 
00112   nsresult List(FILE* out) const;
00113 
00117   PRInt32 GetFlagBits() { return mFlags; }
00118   void AddFlagBits(PRInt32 aBits) { mFlags |= aBits; }
00119   void RemoveFlagBits(PRInt32 aBits) { mFlags &= ~aBits; }
00120 
00124   nsresult GetTarget(nsIFrame*& aTargetFrame) const {
00125     aTargetFrame = mTargetFrame;
00126     return NS_OK;
00127   }
00128 
00129   nsresult GetType(nsReflowType& aReflowType) const {
00130     aReflowType = mType;
00131     return NS_OK;
00132   }
00133   
00134   nsresult GetChildListName(nsIAtom*& aListName) const {
00135     aListName = mListName;
00136     NS_IF_ADDREF(aListName);
00137     return NS_OK;
00138   }
00139 
00140 private:
00141   nsReflowType      mType;
00142   nsIFrame*         mTargetFrame;
00143   nsCOMPtr<nsIAtom> mListName;
00144   // XXXbz remove the flags?  They're not being used for much...
00145   PRInt32         mFlags;
00146 };
00147 
00148 #endif /* nsHTMLReflowCommand_h___ */