1 // Copyright (c) 2014 Marshall A. Greenblatt. All rights reserved. 2 // 3 // Redistribution and use in source and binary forms, with or without 4 // modification, are permitted provided that the following conditions are 5 // met: 6 // 7 // * Redistributions of source code must retain the above copyright 8 // notice, this list of conditions and the following disclaimer. 9 // * Redistributions in binary form must reproduce the above 10 // copyright notice, this list of conditions and the following disclaimer 11 // in the documentation and/or other materials provided with the 12 // distribution. 13 // * Neither the name of Google Inc. nor the name Chromium Embedded 14 // Framework nor the names of its contributors may be used to endorse 15 // or promote products derived from this software without specific prior 16 // written permission. 17 // 18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 // 30 // --------------------------------------------------------------------------- 31 // 32 // The contents of this file must follow a specific format in order to 33 // support the CEF translator tool. See the translator.README.txt file in the 34 // tools directory for more information. 35 // 36 37 #ifndef CEF_INCLUDE_CEF_PRINT_HANDLER_H_ 38 #define CEF_INCLUDE_CEF_PRINT_HANDLER_H_ 39 #pragma once 40 41 #include "include/cef_base.h" 42 #include "include/cef_browser.h" 43 #include "include/cef_print_settings.h" 44 45 /// 46 // Callback interface for asynchronous continuation of print dialog requests. 47 /// 48 /*--cef(source=library)--*/ 49 class CefPrintDialogCallback : public virtual CefBaseRefCounted { 50 public: 51 /// 52 // Continue printing with the specified |settings|. 53 /// 54 /*--cef(capi_name=cont)--*/ 55 virtual void Continue(CefRefPtr<CefPrintSettings> settings) = 0; 56 57 /// 58 // Cancel the printing. 59 /// 60 /*--cef()--*/ 61 virtual void Cancel() = 0; 62 }; 63 64 /// 65 // Callback interface for asynchronous continuation of print job requests. 66 /// 67 /*--cef(source=library)--*/ 68 class CefPrintJobCallback : public virtual CefBaseRefCounted { 69 public: 70 /// 71 // Indicate completion of the print job. 72 /// 73 /*--cef(capi_name=cont)--*/ 74 virtual void Continue() = 0; 75 }; 76 77 /// 78 // Implement this interface to handle printing on Linux. Each browser will have 79 // only one print job in progress at a time. The methods of this class will be 80 // called on the browser process UI thread. 81 /// 82 /*--cef(source=client)--*/ 83 class CefPrintHandler : public virtual CefBaseRefCounted { 84 public: 85 /// 86 // Called when printing has started for the specified |browser|. This method 87 // will be called before the other OnPrint*() methods and irrespective of how 88 // printing was initiated (e.g. CefBrowserHost::Print(), JavaScript 89 // window.print() or PDF extension print button). 90 /// 91 /*--cef()--*/ 92 virtual void OnPrintStart(CefRefPtr<CefBrowser> browser) = 0; 93 94 /// 95 // Synchronize |settings| with client state. If |get_defaults| is true then 96 // populate |settings| with the default print settings. Do not keep a 97 // reference to |settings| outside of this callback. 98 /// 99 /*--cef()--*/ 100 virtual void OnPrintSettings(CefRefPtr<CefBrowser> browser, 101 CefRefPtr<CefPrintSettings> settings, 102 bool get_defaults) = 0; 103 104 /// 105 // Show the print dialog. Execute |callback| once the dialog is dismissed. 106 // Return true if the dialog will be displayed or false to cancel the 107 // printing immediately. 108 /// 109 /*--cef()--*/ 110 virtual bool OnPrintDialog(CefRefPtr<CefBrowser> browser, 111 bool has_selection, 112 CefRefPtr<CefPrintDialogCallback> callback) = 0; 113 114 /// 115 // Send the print job to the printer. Execute |callback| once the job is 116 // completed. Return true if the job will proceed or false to cancel the job 117 // immediately. 118 /// 119 /*--cef()--*/ 120 virtual bool OnPrintJob(CefRefPtr<CefBrowser> browser, 121 const CefString& document_name, 122 const CefString& pdf_file_path, 123 CefRefPtr<CefPrintJobCallback> callback) = 0; 124 125 /// 126 // Reset client state related to printing. 127 /// 128 /*--cef()--*/ 129 virtual void OnPrintReset(CefRefPtr<CefBrowser> browser) = 0; 130 131 /// 132 // Return the PDF paper size in device units. Used in combination with 133 // CefBrowserHost::PrintToPDF(). 134 /// 135 /*--cef()--*/ GetPdfPaperSize(CefRefPtr<CefBrowser> browser,int device_units_per_inch)136 virtual CefSize GetPdfPaperSize(CefRefPtr<CefBrowser> browser, 137 int device_units_per_inch) { 138 return CefSize(); 139 } 140 }; 141 142 #endif // CEF_INCLUDE_CEF_PRINT_HANDLER_H_ 143