• 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=ec13ec3e2819e4ac49792c3a1c57bc60b45fb95b$
37 //
38 
39 #ifndef CEF_INCLUDE_CAPI_CEF_DOWNLOAD_HANDLER_CAPI_H_
40 #define CEF_INCLUDE_CAPI_CEF_DOWNLOAD_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_download_item_capi.h"
46 
47 #ifdef __cplusplus
48 extern "C" {
49 #endif
50 
51 ///
52 // Callback structure used to asynchronously continue a download.
53 ///
54 typedef struct _cef_before_download_callback_t {
55   ///
56   // Base structure.
57   ///
58   cef_base_ref_counted_t base;
59 
60   ///
61   // Call to continue the download. Set |download_path| to the full file path
62   // for the download including the file name or leave blank to use the
63   // suggested name and the default temp directory. Set |show_dialog| to true
64   // (1) if you do wish to show the default "Save As" dialog.
65   ///
66   void(CEF_CALLBACK* cont)(struct _cef_before_download_callback_t* self,
67                            const cef_string_t* download_path,
68                            int show_dialog);
69 } cef_before_download_callback_t;
70 
71 ///
72 // Callback structure used to asynchronously cancel a download.
73 ///
74 typedef struct _cef_download_item_callback_t {
75   ///
76   // Base structure.
77   ///
78   cef_base_ref_counted_t base;
79 
80   ///
81   // Call to cancel the download.
82   ///
83   void(CEF_CALLBACK* cancel)(struct _cef_download_item_callback_t* self);
84 
85   ///
86   // Call to pause the download.
87   ///
88   void(CEF_CALLBACK* pause)(struct _cef_download_item_callback_t* self);
89 
90   ///
91   // Call to resume the download.
92   ///
93   void(CEF_CALLBACK* resume)(struct _cef_download_item_callback_t* self);
94 } cef_download_item_callback_t;
95 
96 ///
97 // Structure used to handle file downloads. The functions of this structure will
98 // called on the browser process UI thread.
99 ///
100 typedef struct _cef_download_handler_t {
101   ///
102   // Base structure.
103   ///
104   cef_base_ref_counted_t base;
105 
106   ///
107   // Called before a download begins. |suggested_name| is the suggested name for
108   // the download file. By default the download will be canceled. Execute
109   // |callback| either asynchronously or in this function to continue the
110   // download if desired. Do not keep a reference to |download_item| outside of
111   // this function.
112   ///
113   void(CEF_CALLBACK* on_before_download)(
114       struct _cef_download_handler_t* self,
115       struct _cef_browser_t* browser,
116       struct _cef_download_item_t* download_item,
117       const cef_string_t* suggested_name,
118       struct _cef_before_download_callback_t* callback);
119 
120   ///
121   // Called when a download's status or progress information has been updated.
122   // This may be called multiple times before and after on_before_download().
123   // Execute |callback| either asynchronously or in this function to cancel the
124   // download if desired. Do not keep a reference to |download_item| outside of
125   // this function.
126   ///
127   void(CEF_CALLBACK* on_download_updated)(
128       struct _cef_download_handler_t* self,
129       struct _cef_browser_t* browser,
130       struct _cef_download_item_t* download_item,
131       struct _cef_download_item_callback_t* callback);
132 } cef_download_handler_t;
133 
134 #ifdef __cplusplus
135 }
136 #endif
137 
138 #endif  // CEF_INCLUDE_CAPI_CEF_DOWNLOAD_HANDLER_CAPI_H_
139