gecko-dev/layout/generic/nsSimplePageSequenceFrame.h
Arnaud Sourioux 676729d71d Bug 973087: Rename nsSimplePageSequence[.h|.cpp] to nsSimplePageSequenceFrame[.h|.cpp] r=roc
--HG--
rename : layout/generic/nsSimplePageSequence.cpp => layout/generic/nsSimplePageSequenceFrame.cpp
rename : layout/generic/nsSimplePageSequence.h => layout/generic/nsSimplePageSequenceFrame.h
2014-02-18 00:58:22 -08:00

168 lines
5.7 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */
#ifndef nsSimplePageSequenceFrame_h___
#define nsSimplePageSequenceFrame_h___
#include "mozilla/Attributes.h"
#include "nsIPageSequenceFrame.h"
#include "nsContainerFrame.h"
#include "nsIPrintSettings.h"
#include "nsIPrintOptions.h"
class nsIDateTimeFormat;
namespace mozilla {
namespace dom {
class HTMLCanvasElement;
}
}
//-----------------------------------------------
// This class maintains all the data that
// is used by all the page frame
// It lives while the nsSimplePageSequenceFrame lives
class nsSharedPageData {
public:
// This object a shared by all the nsPageFrames
// parented to a SimplePageSequenceFrame
nsSharedPageData() : mShrinkToFitRatio(1.0f) {}
nsString mDateTimeStr;
nsString mPageNumFormat;
nsString mPageNumAndTotalsFormat;
nsString mDocTitle;
nsString mDocURL;
nsFont mHeadFootFont;
nsSize mReflowSize;
nsMargin mReflowMargin;
// Margin for headers and footers; it defaults to 4/100 of an inch on UNIX
// and 0 elsewhere; I think it has to do with some inconsistency in page size
// computations
nsMargin mEdgePaperMargin;
nsCOMPtr<nsIPrintSettings> mPrintSettings;
nsCOMPtr<nsIPrintOptions> mPrintOptions;
// The scaling ratio we need to apply to make all pages fit horizontally. It's
// the minimum "ComputedWidth / OverflowWidth" ratio of all page content frames
// that overflowed. It's 1.0 if none overflowed horizontally.
float mShrinkToFitRatio;
};
// Simple page sequence frame class. Used when we're in paginated mode
class nsSimplePageSequenceFrame : public nsContainerFrame,
public nsIPageSequenceFrame {
public:
friend nsIFrame* NS_NewSimplePageSequenceFrame(nsIPresShell* aPresShell, nsStyleContext* aContext);
NS_DECL_QUERYFRAME
NS_DECL_FRAMEARENA_HELPERS
// nsIFrame
virtual nsresult Reflow(nsPresContext* aPresContext,
nsHTMLReflowMetrics& aDesiredSize,
const nsHTMLReflowState& aMaxSize,
nsReflowStatus& aStatus) MOZ_OVERRIDE;
virtual void BuildDisplayList(nsDisplayListBuilder* aBuilder,
const nsRect& aDirtyRect,
const nsDisplayListSet& aLists) MOZ_OVERRIDE;
// nsIPageSequenceFrame
NS_IMETHOD SetPageNo(int32_t aPageNo) { return NS_OK;}
NS_IMETHOD SetSelectionHeight(nscoord aYOffset, nscoord aHeight) MOZ_OVERRIDE { mYSelOffset = aYOffset; mSelectionHeight = aHeight; return NS_OK; }
NS_IMETHOD SetTotalNumPages(int32_t aTotal) MOZ_OVERRIDE { mTotalPages = aTotal; return NS_OK; }
// For Shrink To Fit
NS_IMETHOD GetSTFPercent(float& aSTFPercent) MOZ_OVERRIDE;
// Async Printing
NS_IMETHOD StartPrint(nsPresContext* aPresContext,
nsIPrintSettings* aPrintSettings,
const nsAString& aDocTitle,
const nsAString& aDocURL) MOZ_OVERRIDE;
NS_IMETHOD PrePrintNextPage(nsITimerCallback* aCallback, bool* aDone) MOZ_OVERRIDE;
NS_IMETHOD PrintNextPage() MOZ_OVERRIDE;
NS_IMETHOD ResetPrintCanvasList() MOZ_OVERRIDE;
NS_IMETHOD GetCurrentPageNum(int32_t* aPageNum) MOZ_OVERRIDE;
NS_IMETHOD GetNumPages(int32_t* aNumPages) MOZ_OVERRIDE;
NS_IMETHOD IsDoingPrintRange(bool* aDoing) MOZ_OVERRIDE;
NS_IMETHOD GetPrintRange(int32_t* aFromPage, int32_t* aToPage) MOZ_OVERRIDE;
NS_IMETHOD DoPageEnd() MOZ_OVERRIDE;
// We must allow Print Preview UI to have a background, no matter what the
// user's settings
virtual bool HonorPrintBackgroundSettings() MOZ_OVERRIDE { return false; }
virtual bool HasTransformGetter() const MOZ_OVERRIDE { return true; }
/**
* Get the "type" of the frame
*
* @see nsGkAtoms::sequenceFrame
*/
virtual nsIAtom* GetType() const MOZ_OVERRIDE;
#ifdef DEBUG_FRAME_DUMP
virtual nsresult GetFrameName(nsAString& aResult) const MOZ_OVERRIDE;
#endif
protected:
nsSimplePageSequenceFrame(nsStyleContext* aContext);
virtual ~nsSimplePageSequenceFrame();
void SetPageNumberFormat(const char* aPropName, const char* aDefPropVal, bool aPageNumOnly);
// SharedPageData Helper methods
void SetDateTimeStr(const nsAString& aDateTimeStr);
void SetPageNumberFormat(const nsAString& aFormatStr, bool aForPageNumOnly);
// Sets the frame desired size to the size of the viewport, or the given
// nscoords, whichever is larger. Print scaling is applied in this function.
void SetDesiredSize(nsHTMLReflowMetrics& aDesiredSize,
const nsHTMLReflowState& aReflowState,
nscoord aWidth, nscoord aHeight);
void DetermineWhetherToPrintPage();
nsIFrame* GetCurrentPageFrame();
nsMargin mMargin;
// I18N date formatter service which we'll want to cache locally.
nsCOMPtr<nsIDateTimeFormat> mDateFormatter;
nsSize mSize;
nsSharedPageData* mPageData; // data shared by all the nsPageFrames
// Asynch Printing
int32_t mPageNum;
int32_t mTotalPages;
int32_t mPrintRangeType;
int32_t mFromPageNum;
int32_t mToPageNum;
nsTArray<int32_t> mPageRanges;
nsTArray<nsRefPtr<mozilla::dom::HTMLCanvasElement> > mCurrentCanvasList;
// Selection Printing Info
nscoord mSelectionHeight;
nscoord mYSelOffset;
// Asynch Printing
bool mPrintThisPage;
bool mDoingPageRange;
bool mIsPrintingSelection;
bool mCalledBeginPage;
bool mCurrentCanvasListSetup;
};
#endif /* nsSimplePageSequenceFrame_h___ */