• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright (c) 2022 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 // This file was generated by the CEF translator tool and should not edited
33 // by hand. See the translator.README.txt file in the tools directory for
34 // more information.
35 //
36 // $hash=e26be3efc18d8c79d019c02b1d73a7ec2866b142$
37 //
38 
39 #ifndef CEF_INCLUDE_CAPI_CEF_PRINT_HANDLER_CAPI_H_
40 #define CEF_INCLUDE_CAPI_CEF_PRINT_HANDLER_CAPI_H_
41 #pragma once
42 
43 #include "include/capi/cef_base_capi.h"
44 #include "include/capi/cef_browser_capi.h"
45 #include "include/capi/cef_print_settings_capi.h"
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 ///
52 // Callback structure for asynchronous continuation of print dialog requests.
53 ///
54 typedef struct _cef_print_dialog_callback_t {
55   ///
56   // Base structure.
57   ///
58   cef_base_ref_counted_t base;
59 
60   ///
61   // Continue printing with the specified |settings|.
62   ///
63   void(CEF_CALLBACK* cont)(struct _cef_print_dialog_callback_t* self,
64                            struct _cef_print_settings_t* settings);
65 
66   ///
67   // Cancel the printing.
68   ///
69   void(CEF_CALLBACK* cancel)(struct _cef_print_dialog_callback_t* self);
70 } cef_print_dialog_callback_t;
71 
72 ///
73 // Callback structure for asynchronous continuation of print job requests.
74 ///
75 typedef struct _cef_print_job_callback_t {
76   ///
77   // Base structure.
78   ///
79   cef_base_ref_counted_t base;
80 
81   ///
82   // Indicate completion of the print job.
83   ///
84   void(CEF_CALLBACK* cont)(struct _cef_print_job_callback_t* self);
85 } cef_print_job_callback_t;
86 
87 ///
88 // Implement this structure to handle printing on Linux. Each browser will have
89 // only one print job in progress at a time. The functions of this structure
90 // will be called on the browser process UI thread.
91 ///
92 typedef struct _cef_print_handler_t {
93   ///
94   // Base structure.
95   ///
96   cef_base_ref_counted_t base;
97 
98   ///
99   // Called when printing has started for the specified |browser|. This function
100   // will be called before the other OnPrint*() functions and irrespective of
101   // how printing was initiated (e.g. cef_browser_host_t::print(), JavaScript
102   // window.print() or PDF extension print button).
103   ///
104   void(CEF_CALLBACK* on_print_start)(struct _cef_print_handler_t* self,
105                                      struct _cef_browser_t* browser);
106 
107   ///
108   // Synchronize |settings| with client state. If |get_defaults| is true (1)
109   // then populate |settings| with the default print settings. Do not keep a
110   // reference to |settings| outside of this callback.
111   ///
112   void(CEF_CALLBACK* on_print_settings)(struct _cef_print_handler_t* self,
113                                         struct _cef_browser_t* browser,
114                                         struct _cef_print_settings_t* settings,
115                                         int get_defaults);
116 
117   ///
118   // Show the print dialog. Execute |callback| once the dialog is dismissed.
119   // Return true (1) if the dialog will be displayed or false (0) to cancel the
120   // printing immediately.
121   ///
122   int(CEF_CALLBACK* on_print_dialog)(
123       struct _cef_print_handler_t* self,
124       struct _cef_browser_t* browser,
125       int has_selection,
126       struct _cef_print_dialog_callback_t* callback);
127 
128   ///
129   // Send the print job to the printer. Execute |callback| once the job is
130   // completed. Return true (1) if the job will proceed or false (0) to cancel
131   // the job immediately.
132   ///
133   int(CEF_CALLBACK* on_print_job)(struct _cef_print_handler_t* self,
134                                   struct _cef_browser_t* browser,
135                                   const cef_string_t* document_name,
136                                   const cef_string_t* pdf_file_path,
137                                   struct _cef_print_job_callback_t* callback);
138 
139   ///
140   // Reset client state related to printing.
141   ///
142   void(CEF_CALLBACK* on_print_reset)(struct _cef_print_handler_t* self,
143                                      struct _cef_browser_t* browser);
144 
145   ///
146   // Return the PDF paper size in device units. Used in combination with
147   // cef_browser_host_t::print_to_pdf().
148   ///
149   cef_size_t(CEF_CALLBACK* get_pdf_paper_size)(
150       struct _cef_print_handler_t* self,
151       struct _cef_browser_t* browser,
152       int device_units_per_inch);
153 } cef_print_handler_t;
154 
155 #ifdef __cplusplus
156 }
157 #endif
158 
159 #endif  // CEF_INCLUDE_CAPI_CEF_PRINT_HANDLER_CAPI_H_
160