Back to index

lightning-sunbird  0.9+nobinonly
nsBlockBandData.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 Communicator client 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 nsBlockBandData_h___
00038 #define nsBlockBandData_h___
00039 
00040 #include "nsSpaceManager.h"
00041 
00042 class nsPresContext;
00043 
00044 // Number of builtin nsBandTrapezoid's
00045 #define NS_BLOCK_BAND_DATA_TRAPS 6
00046 
00051 class nsBlockBandData : public nsBandData {
00052 public:
00053   nsBlockBandData();
00054   ~nsBlockBandData();
00055 
00056   // Initialize. This must be called before any of the other methods.
00057   nsresult Init(nsSpaceManager* aSpaceManager, const nsSize& aSpace);
00058 
00059   // Get some available space. Note that aY is relative to the current
00060   // space manager translation.
00061   nsresult GetAvailableSpace(nscoord aY, PRBool aRelaxHeightConstraint,
00062                              nsRect& aResult);
00063 
00064   // Get the raw trapezoid count for this band.
00065   PRInt32 GetTrapezoidCount() const {
00066     return mCount;
00067   }
00068 
00069   const nsBandTrapezoid* GetTrapezoid(PRInt32 aIndex) const {
00070     return &mTrapezoids[aIndex];
00071   }
00072 
00073   // Get the number of floats that are impacting the current
00074   // band. Note that this value is relative to the current translation
00075   // in the space manager which means that some floats may be hidden
00076   // by the translation and therefore won't be in the count.
00077   PRInt32 GetFloatCount() const {
00078     return mLeftFloats + mRightFloats;
00079   }
00080   PRInt32 GetLeftFloatCount() const {
00081     return mLeftFloats;
00082   }
00083   PRInt32 GetRightFloatCount() const {
00084     return mRightFloats;
00085   }
00086 
00087 #ifdef DEBUG
00088   void List();
00089 #endif
00090 
00091 protected:
00092 
00099   nsresult GetBandData(nscoord aY, PRBool aRelaxHeightConstraint);
00100 
00101   // The spacemanager we are getting space from
00102   nsSpaceManager* mSpaceManager;
00103   nscoord mSpaceManagerX, mSpaceManagerY;
00104 
00105   // Limit to the available space (set by Init)
00106   nsSize mSpace;
00107 
00108   // Trapezoids used during band processing
00109   nsBandTrapezoid mData[NS_BLOCK_BAND_DATA_TRAPS];
00110 
00111   // Bounding rect of available space between any left and right floats
00112   nsRect mAvailSpace;
00113 
00114   // Number of left/right floats in the current band. Note that this
00115   // number may be less than the total number of floats present in
00116   // the band, if our translation in the space manager "hides" some
00117   // floats.
00118   PRInt32 mLeftFloats, mRightFloats;
00119 
00120   void ComputeAvailSpaceRect();
00121 };
00122 
00123 #endif /* nsBlockBandData_h___ */