1 // Copyright (c) 2012 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_DOWNLOAD_HANDLER_H_ 38 #define CEF_INCLUDE_CEF_DOWNLOAD_HANDLER_H_ 39 #pragma once 40 41 #include "include/cef_base.h" 42 #include "include/cef_browser.h" 43 #include "include/cef_download_item.h" 44 45 /// 46 // Callback interface used to asynchronously continue a download. 47 /// 48 /*--cef(source=library)--*/ 49 class CefBeforeDownloadCallback : public virtual CefBaseRefCounted { 50 public: 51 /// 52 // Call to continue the download. Set |download_path| to the full file path 53 // for the download including the file name or leave blank to use the 54 // suggested name and the default temp directory. Set |show_dialog| to true 55 // if you do wish to show the default "Save As" dialog. 56 /// 57 /*--cef(capi_name=cont,optional_param=download_path)--*/ 58 virtual void Continue(const CefString& download_path, bool show_dialog) = 0; 59 }; 60 61 /// 62 // Callback interface used to asynchronously cancel a download. 63 /// 64 /*--cef(source=library)--*/ 65 class CefDownloadItemCallback : public virtual CefBaseRefCounted { 66 public: 67 /// 68 // Call to cancel the download. 69 /// 70 /*--cef()--*/ 71 virtual void Cancel() = 0; 72 73 /// 74 // Call to pause the download. 75 /// 76 /*--cef()--*/ 77 virtual void Pause() = 0; 78 79 /// 80 // Call to resume the download. 81 /// 82 /*--cef()--*/ 83 virtual void Resume() = 0; 84 }; 85 86 /// 87 // Class used to handle file downloads. The methods of this class will called 88 // on the browser process UI thread. 89 /// 90 /*--cef(source=client)--*/ 91 class CefDownloadHandler : public virtual CefBaseRefCounted { 92 public: 93 /// 94 // Called before a download begins. |suggested_name| is the suggested name for 95 // the download file. By default the download will be canceled. Execute 96 // |callback| either asynchronously or in this method to continue the download 97 // if desired. Do not keep a reference to |download_item| outside of this 98 // method. 99 /// 100 /*--cef()--*/ 101 virtual void OnBeforeDownload( 102 CefRefPtr<CefBrowser> browser, 103 CefRefPtr<CefDownloadItem> download_item, 104 const CefString& suggested_name, 105 CefRefPtr<CefBeforeDownloadCallback> callback) = 0; 106 107 /// 108 // Called when a download's status or progress information has been updated. 109 // This may be called multiple times before and after OnBeforeDownload(). 110 // Execute |callback| either asynchronously or in this method to cancel the 111 // download if desired. Do not keep a reference to |download_item| outside of 112 // this method. 113 /// 114 /*--cef()--*/ OnDownloadUpdated(CefRefPtr<CefBrowser> browser,CefRefPtr<CefDownloadItem> download_item,CefRefPtr<CefDownloadItemCallback> callback)115 virtual void OnDownloadUpdated(CefRefPtr<CefBrowser> browser, 116 CefRefPtr<CefDownloadItem> download_item, 117 CefRefPtr<CefDownloadItemCallback> callback) {} 118 }; 119 120 #endif // CEF_INCLUDE_CEF_DOWNLOAD_HANDLER_H_ 121