1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
|
// Copyright (c) 2011 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CHROME_RENDERER_PRINT_WEB_VIEW_HELPER_H_
#define CHROME_RENDERER_PRINT_WEB_VIEW_HELPER_H_
#pragma once
#include "base/scoped_ptr.h"
#include "base/shared_memory.h"
#include "base/time.h"
#include "chrome/renderer/render_view_observer.h"
#include "printing/native_metafile.h"
#include "third_party/WebKit/Source/WebKit/chromium/public/WebFrameClient.h"
#include "third_party/WebKit/Source/WebKit/chromium/public/WebViewClient.h"
#include "ui/gfx/size.h"
class DictionaryValue;
struct ViewMsg_Print_Params;
struct ViewMsg_PrintPage_Params;
struct ViewMsg_PrintPages_Params;
#if defined(USE_X11)
namespace skia {
class VectorCanvas;
}
#endif
// Class that calls the Begin and End print functions on the frame and changes
// the size of the view temporarily to support full page printing..
// Do not serve any events in the time between construction and destruction of
// this class because it will cause flicker.
class PrepareFrameAndViewForPrint {
public:
// Prints |frame|. If |node| is not NULL, then only that node will be
// printed.
PrepareFrameAndViewForPrint(const ViewMsg_Print_Params& print_params,
WebKit::WebFrame* frame,
WebKit::WebNode* node,
WebKit::WebView* web_view);
~PrepareFrameAndViewForPrint();
int GetExpectedPageCount() const {
return expected_pages_count_;
}
bool ShouldUseBrowserOverlays() const {
return use_browser_overlays_;
}
const gfx::Size& GetPrintCanvasSize() const {
return print_canvas_size_;
}
private:
WebKit::WebFrame* frame_;
WebKit::WebView* web_view_;
gfx::Size print_canvas_size_;
gfx::Size prev_view_size_;
gfx::Size prev_scroll_offset_;
int expected_pages_count_;
bool use_browser_overlays_;
DISALLOW_COPY_AND_ASSIGN(PrepareFrameAndViewForPrint);
};
// PrintWebViewHelper handles most of the printing grunt work for RenderView.
// We plan on making print asynchronous and that will require copying the DOM
// of the document and creating a new WebView with the contents.
class PrintWebViewHelper : public RenderViewObserver ,
public WebKit::WebViewClient,
public WebKit::WebFrameClient {
public:
explicit PrintWebViewHelper(RenderView* render_view);
virtual ~PrintWebViewHelper();
// Prints |frame| which called window.print().
void ScriptInitiatedPrint(WebKit::WebFrame* frame);
protected:
// WebKit::WebViewClient override:
virtual void didStopLoading();
private:
friend class RenderViewTest_OnPrintPages_Test;
#if defined(OS_WIN) || defined(OS_MACOSX)
FRIEND_TEST_ALL_PREFIXES(RenderViewTest, PrintLayoutTest);
FRIEND_TEST_ALL_PREFIXES(RenderViewTest, PrintWithIframe);
#endif // defined(OS_WIN) || defined(OS_MACOSX)
// RenderViewObserver implementation.
virtual bool OnMessageReceived(const IPC::Message& message);
// Message handlers ---------------------------------------------------------
// Print the document or generate a print preview.
void OnPrintPages();
void OnPrintPreview();
// Common method for OnPrintPages() and OnPrintPreview().
void OnPrint();
// Print / preview the node under the context menu.
void OnPrintNodeUnderContextMenu();
// Print the pages for print preview. Do not display the native print dialog
// for user settings. |job_settings| has new print job settings values.
void OnPrintForPrintPreview(const DictionaryValue& job_settings);
void OnPrintingDone(int document_cookie, bool success);
// Main printing code -------------------------------------------------------
void Print(WebKit::WebFrame* frame,
WebKit::WebNode* node,
bool script_initiated);
// Notification when printing is done - signal teardown.
void DidFinishPrinting(bool success);
// Print Settings -----------------------------------------------------------
// Initialize print page settings with default settings.
bool InitPrintSettings(WebKit::WebFrame* frame,
WebKit::WebNode* node);
// Update the current print settings with new |job_settings|. |job_settings|
// dictionary contains print job details such as printer name, number of
// copies, page range, etc.
bool UpdatePrintSettings(const DictionaryValue& job_settings);
// Get final print settings from the user.
// Return false if the user cancels or on error.
bool GetPrintSettingsFromUser(WebKit::WebFrame* frame,
int expected_pages_count,
bool use_browser_overlays);
// Page Printing / Rendering ------------------------------------------------
// Prints all the pages listed in |params|.
// It will implicitly revert the document to display CSS media type.
void PrintPages(const ViewMsg_PrintPages_Params& params,
WebKit::WebFrame* frame,
WebKit::WebNode* node);
// Prints the page listed in |params|.
#if defined(USE_X11)
void PrintPage(const ViewMsg_PrintPage_Params& params,
const gfx::Size& canvas_size,
WebKit::WebFrame* frame,
printing::NativeMetafile* metafile,
scoped_ptr<skia::VectorCanvas>* canvas);
#else
void PrintPage(const ViewMsg_PrintPage_Params& params,
const gfx::Size& canvas_size,
WebKit::WebFrame* frame);
#endif
// Render the frame for printing.
void RenderPagesForPrint(WebKit::WebFrame* frame,
WebKit::WebNode* node);
// Render the frame for preview.
void RenderPagesForPreview(WebKit::WebFrame* frame);
// Renders all the pages listed in |params| for preview.
// On Success, Send ViewHostMsg_PagesReadyForPreview message with a
// valid metafile data handle.
void CreatePreviewDocument(const ViewMsg_PrintPages_Params& params,
WebKit::WebFrame* frame);
// Platform specific helper function for rendering page(s) to |metafile|.
#if defined(OS_WIN)
void RenderPage(const ViewMsg_Print_Params& params, float* scale_factor,
int page_number, WebKit::WebFrame* frame,
scoped_ptr<printing::NativeMetafile>* metafile);
#elif defined(OS_MACOSX)
void RenderPage(const gfx::Size& page_size, const gfx::Point& content_origin,
const float& scale_factor, int page_number,
WebKit::WebFrame* frame, printing::NativeMetafile* metafile);
#elif defined(OS_POSIX)
bool RenderPages(const ViewMsg_PrintPages_Params& params,
WebKit::WebFrame* frame,
bool send_expected_page_count,
int* page_count,
printing::NativeMetafile* metafile);
#endif // defined(OS_WIN)
// Helper methods -----------------------------------------------------------
bool CopyAndPrint(WebKit::WebFrame* web_frame);
bool CopyMetafileDataToSharedMem(printing::NativeMetafile* metafile,
base::SharedMemoryHandle* shared_mem_handle);
static void GetPageSizeAndMarginsInPoints(
WebKit::WebFrame* frame,
int page_index,
const ViewMsg_Print_Params& default_params,
double* content_width_in_points,
double* content_height_in_points,
double* margin_top_in_points,
double* margin_right_in_points,
double* margin_bottom_in_points,
double* margin_left_in_points);
void UpdatePrintableSizeInPrintParameters(WebKit::WebFrame* frame,
WebKit::WebNode* node,
ViewMsg_Print_Params* params);
// Script Initiated Printing ------------------------------------------------
// Returns true if script initiated printing occurs too often.
bool IsScriptInitiatedPrintTooFrequent(WebKit::WebFrame* frame);
// Reset the counter for script initiated printing.
// Scripted printing will be allowed to continue.
void ResetScriptedPrintCount();
// Increment the counter for script initiated printing.
// Scripted printing will be blocked for a limited amount of time.
void IncrementScriptedPrintCount();
WebKit::WebView* print_web_view_;
scoped_ptr<ViewMsg_PrintPages_Params> print_pages_params_;
base::Time last_cancelled_script_print_;
int user_cancelled_scripted_print_count_;
bool is_preview_;
DISALLOW_COPY_AND_ASSIGN(PrintWebViewHelper);
};
#endif // CHROME_RENDERER_PRINT_WEB_VIEW_HELPER_H_
|
