1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef PRINTING_PRINTING_CONTEXT_H_
6 #define PRINTING_PRINTING_CONTEXT_H_
10 #include "base/basictypes.h"
11 #include "base/callback.h"
12 #include "base/strings/string16.h"
13 #include "printing/print_settings.h"
14 #include "ui/gfx/native_widget_types.h"
17 class DictionaryValue
;
22 // An abstraction of a printer context, implemented by objects that describe the
23 // user selected printing context. This includes the OS-dependent UI to ask the
24 // user about the print settings. Concrete implementations directly talk to the
25 // printer and manage the document and page breaks.
26 class PRINTING_EXPORT PrintingContext
{
28 // Tri-state result for user behavior-dependent functions.
35 virtual ~PrintingContext();
37 // Callback of AskUserForSettings, used to notify the PrintJobWorker when
38 // print settings are available.
39 typedef base::Callback
<void(Result
)> PrintSettingsCallback
;
41 // Asks the user what printer and format should be used to print. Updates the
42 // context with the select device settings. The result of the call is returned
43 // in the callback. This is necessary for Linux, which only has an
44 // asynchronous printing API.
45 virtual void AskUserForSettings(gfx::NativeView parent_view
,
48 const PrintSettingsCallback
& callback
) = 0;
50 // Selects the user's default printer and format. Updates the context with the
51 // default device settings.
52 virtual Result
UseDefaultSettings() = 0;
54 // Returns paper size to be used for PDF or Cloud Print in device units.
55 virtual gfx::Size
GetPdfPaperSizeDeviceUnits() = 0;
57 // Updates printer settings.
58 // |external_preview| is true if pdf is going to be opened in external
59 // preview. Used by MacOS only now to open Preview.app.
60 virtual Result
UpdatePrinterSettings(bool external_preview
) = 0;
62 // Updates Print Settings. |job_settings| contains all print job
63 // settings information. |ranges| has the new page range settings.
64 Result
UpdatePrintSettings(const base::DictionaryValue
& job_settings
,
65 const PageRanges
& ranges
);
67 // Initializes with predefined settings.
68 virtual Result
InitWithSettings(const PrintSettings
& settings
) = 0;
70 // Does platform specific setup of the printer before the printing. Signal the
71 // printer that a document is about to be spooled.
72 // Warning: This function enters a message loop. That may cause side effects
73 // like IPC message processing! Some printers have side-effects on this call
74 // like virtual printers that ask the user for the path of the saved document;
75 // for example a PDF printer.
76 virtual Result
NewDocument(const base::string16
& document_name
) = 0;
79 virtual Result
NewPage() = 0;
81 // Closes the printed page.
82 virtual Result
PageDone() = 0;
84 // Closes the printing job. After this call the object is ready to start a new
86 virtual Result
DocumentDone() = 0;
88 // Cancels printing. Can be used in a multi-threaded context. Takes effect
90 virtual void Cancel() = 0;
92 // Releases the native printing context.
93 virtual void ReleaseContext() = 0;
95 // Returns the native context used to print.
96 virtual gfx::NativeDrawingContext
context() const = 0;
98 // Creates an instance of this object. Implementers of this interface should
99 // implement this method to create an object of their implementation. The
100 // caller owns the returned object.
101 static PrintingContext
* Create(const std::string
& app_locale
);
103 void set_margin_type(MarginType type
);
105 const PrintSettings
& settings() const {
110 explicit PrintingContext(const std::string
& app_locale
);
112 // Reinitializes the settings for object reuse.
113 void ResetSettings();
115 // Does bookkeeping when an error occurs.
116 PrintingContext::Result
OnError();
118 // Complete print context settings.
119 PrintSettings settings_
;
121 // The dialog box has been dismissed.
122 volatile bool dialog_box_dismissed_
;
124 // Is a print job being done.
125 volatile bool in_print_job_
;
127 // Did the user cancel the print job.
128 volatile bool abort_printing_
;
130 // The application locale.
131 std::string app_locale_
;
134 DISALLOW_COPY_AND_ASSIGN(PrintingContext
);
137 } // namespace printing
139 #endif // PRINTING_PRINTING_CONTEXT_H_