• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2007 Alp Toker <alp@atoker.com>
3  * Copyright (C) 2007 Apple Inc.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20 
21 #ifndef PrintContext_h
22 #define PrintContext_h
23 
24 #include "wtf/Forward.h"
25 #include "wtf/HashMap.h"
26 #include "wtf/Vector.h"
27 #include "wtf/text/WTFString.h"
28 
29 namespace WebCore {
30 
31 class Element;
32 class LocalFrame;
33 class FloatRect;
34 class FloatSize;
35 class GraphicsContext;
36 class IntRect;
37 class Node;
38 
39 class PrintContext {
40 public:
41     explicit PrintContext(LocalFrame*);
42     ~PrintContext();
43 
frame()44     LocalFrame* frame() const { return m_frame; }
45 
46     // Break up a page into rects without relayout.
47     // FIXME: This means that CSS page breaks won't be on page boundary if the size is different than what was passed to begin(). That's probably not always desirable.
48     // FIXME: Header and footer height should be applied before layout, not after.
49     // FIXME: The printRect argument is only used to determine page aspect ratio, it would be better to pass a FloatSize with page dimensions instead.
50     void computePageRects(const FloatRect& printRect, float headerHeight, float footerHeight, float userScaleFactor, float& outPageHeight, bool allowHorizontalTiling = false);
51 
52     // Deprecated. Page size computation is already in this class, clients shouldn't be copying it.
53     void computePageRectsWithPageSize(const FloatSize& pageSizeInPixels, bool allowHorizontalTiling);
54 
55     // These are only valid after page rects are computed.
pageCount()56     size_t pageCount() const { return m_pageRects.size(); }
pageRect(size_t pageNumber)57     const IntRect& pageRect(size_t pageNumber) const { return m_pageRects[pageNumber]; }
pageRects()58     const Vector<IntRect>& pageRects() const { return m_pageRects; }
59 
60     // Enter print mode, updating layout for new page size.
61     // This function can be called multiple times to apply new print options without going back to screen mode.
62     void begin(float width, float height = 0);
63 
64     // FIXME: eliminate width argument.
65     void spoolPage(GraphicsContext& ctx, int pageNumber, float width);
66 
67     // Return to screen mode.
68     void end();
69 
70     // Used by layout tests.
71     static int pageNumberForElement(Element*, const FloatSize& pageSizeInPixels); // Returns -1 if page isn't found.
72     static String pageProperty(LocalFrame* frame, const char* propertyName, int pageNumber);
73     static bool isPageBoxVisible(LocalFrame* frame, int pageNumber);
74     static String pageSizeAndMarginsInPixels(LocalFrame* frame, int pageNumber, int width, int height, int marginTop, int marginRight, int marginBottom, int marginLeft);
75     static int numberOfPages(LocalFrame*, const FloatSize& pageSizeInPixels);
76     // Draw all pages into a graphics context with lines which mean page boundaries.
77     // The height of the graphics context should be
78     // (pageSizeInPixels.height() + 1) * number-of-pages - 1
79     static void spoolAllPagesWithBoundaries(LocalFrame*, GraphicsContext&, const FloatSize& pageSizeInPixels);
80 
81 protected:
82     void outputLinkedDestinations(GraphicsContext&, Node*, const IntRect& pageRect);
83 
84     LocalFrame* m_frame;
85     Vector<IntRect> m_pageRects;
86 
87 private:
88     void computePageRectsWithPageSizeInternal(const FloatSize& pageSizeInPixels, bool allowHorizontalTiling);
89     void collectLinkedDestinations(Node*);
90 
91     // Used to prevent misuses of begin() and end() (e.g., call end without begin).
92     bool m_isPrinting;
93 
94     HashMap<String, Element*> m_linkedDestinations;
95     bool m_linkedDestinationsValid;
96 };
97 
98 }
99 
100 #endif
101