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
|
// Copyright 2019 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.
module printing.mojom;
import "mojo/public/mojom/base/shared_memory.mojom";
import "mojo/public/mojom/base/values.mojom";
import "printing/mojom/print.mojom";
import "ui/gfx/geometry/mojom/geometry.mojom";
// Parameters required to print the content of an out-of-process subframe.
struct PrintFrameContentParams {
// Physical printable area of the page in pixels according to dpi.
gfx.mojom.Rect printable_area;
// Cookie that is unique for each print request. It is used to associate the
// printed frame with its original print request.
int32 document_cookie;
};
// Parameters required to set options from a document.
struct OptionsFromDocumentParams {
// Specifies whether print scaling is enabled or not.
bool is_scaling_disabled;
// Specifies number of copies to be printed.
int32 copies;
// Specifies paper handling option.
DuplexMode duplex;
};
// Holds the printed content information.
// The printed content is in shared memory, and passed as a region.
// A map on out-of-process subframe contents is also included so the printed
// content can be composited as needed.
struct DidPrintContentParams {
// A shared memory region for the metafile data.
mojo_base.mojom.ReadOnlySharedMemoryRegion metafile_data_region;
// Content id to render frame proxy id mapping for out-of-process subframes.
map<uint32, int32> subframe_content_info;
};
// Parameters to describe the to-be-rendered preview document.
struct DidStartPreviewParams {
// Total page count for the rendered preview. (Not the number of pages the
// user selected to print.)
int32 page_count;
// The list of 0-based page numbers that will be rendered.
array<int32> pages_to_render;
// number of pages per sheet and should be greater or equal to 1.
int32 pages_per_sheet;
// Physical size of the page, including non-printable margins.
gfx.mojom.Size page_size;
// Scaling % to fit to page
int32 fit_to_page_scaling;
};
// Interface implemented by a class that desires to render print documents for
// Chrome print preview.
interface PrintRenderer {
// Creates a preview document for print preview using the provided
// |job_settings|.
// The returned |preview_document_region| contains the preview document data
// as a flattened PDF. It will be invalid if errors occurred while rendering
// the preview document.
CreatePreviewDocument(mojo_base.mojom.DictionaryValue job_settings)
=> (mojo_base.mojom.ReadOnlySharedMemoryRegion? preview_document_region);
};
// Browser process interface exposed to the renderer to handle the print
// preview UI.
interface PrintPreviewUI {
// Notifies the WebUI to set print preset options from source PDF.
// |request_id| comes from the chrome://print WebUI when it requests to update
// the print preview.
[EnableIf=enable_print_preview]
SetOptionsFromDocument(OptionsFromDocumentParams params, int32 request_id);
// Tells the browser print preview failed. |document_cookie| is the param to
// ensure correctness and |request_id| is the id for the preview request.
[EnableIf=enable_print_preview]
PrintPreviewFailed(int32 document_cookie, int32 request_id);
// Tell the browser print preview was cancelled. |document_cookie| is the
// param to ensure correctness and |request_id| is the id for the preview
// request.
[EnableIf=enable_print_preview]
PrintPreviewCancelled(int32 document_cookie, int32 request_id);
// Tell the browser print preview found the selected printer has invalid
// settings (which typically caused by disconnected network printer or
// printer driver is bogus).
[EnableIf=enable_print_preview]
PrinterSettingsInvalid(int32 document_cookie, int32 request_id);
};
// Render process interface exposed to the browser to handle most of the
// printing grunt work for RenderView.
interface PrintRenderFrame {
// Tells the RenderFrame to switch the CSS to print media type, render every
// requested page, and then switch back the CSS to display media type.
PrintRequestedPages();
// Tells the RenderFrame to switch the CSS to print media type, render every
// requested page using the print preview document's frame/node, and then
// switch the CSS back to display media type.
PrintForSystemDialog();
// Tells the RenderFrame to initiate print preview for the entire document.
// Optionally provides a |print_renderer| to render print documents.
[EnableIf=enable_print_preview]
InitiatePrintPreview(pending_associated_remote<PrintRenderer>? print_renderer,
bool has_selection);
// Sets PrintPreviewUI interface to notify the browser of preview actions.
[EnableIf=enable_print_preview]
SetPrintPreviewUI(pending_associated_remote<PrintPreviewUI> preview);
// Tells the RenderFrame to switch the CSS to print media type and render
// every requested page for print preview using the given |settings|. This
// gets called multiple times as the user updates settings.
[EnableIf=enable_print_preview]
PrintPreview(mojo_base.mojom.DictionaryValue settings);
// Tells the RenderFrame that the print preview dialog was closed.
[EnableIf=enable_print_preview]
OnPrintPreviewDialogClosed();
// Prints the content of an out-of-process subframe. Replies back to the
// browser the rendered subframe content that was requested.
PrintFrameContent(PrintFrameContentParams params)
=> (int32 document_cookie, DidPrintContentParams params);
// Tells the RenderFrame whether printing is enabled or not.
SetPrintingEnabled(bool enabled);
// Tells the RenderFrame that printing is done so it can clean up.
PrintingDone(bool success);
// Tells the RenderFrame to initiate printing or print preview for a
// particular node, depending on which mode the RenderFrame is in.
PrintNodeUnderContextMenu();
};
|
