git.sesse.net Git - casparcg/blob - dependencies64/cef/windows/include/capi/cef_dialog_handler_capi.h

   1 // Copyright (c) 2017 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
  37 #ifndef CEF_INCLUDE_CAPI_CEF_DIALOG_HANDLER_CAPI_H_
  38 #define CEF_INCLUDE_CAPI_CEF_DIALOG_HANDLER_CAPI_H_
  39 #pragma once
  40
  41 #include "include/capi/cef_base_capi.h"
  42 #include "include/capi/cef_browser_capi.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48
  49 ///
  50 // Callback structure for asynchronous continuation of file dialog requests.
  51 ///
  52 typedef struct _cef_file_dialog_callback_t {
  53   ///
  54   // Base structure.
  55   ///
  56   cef_base_ref_counted_t base;
  57
  58   ///
  59   // Continue the file selection. |selected_accept_filter| should be the 0-based
  60   // index of the value selected from the accept filters array passed to
  61   // cef_dialog_handler_t::OnFileDialog. |file_paths| should be a single value
  62   // or a list of values depending on the dialog mode. An NULL |file_paths|
  63   // value is treated the same as calling cancel().
  64   ///
  65   void (CEF_CALLBACK *cont)(struct _cef_file_dialog_callback_t* self,
  66       int selected_accept_filter, cef_string_list_t file_paths);
  67
  68   ///
  69   // Cancel the file selection.
  70   ///
  71   void (CEF_CALLBACK *cancel)(struct _cef_file_dialog_callback_t* self);
  72 } cef_file_dialog_callback_t;
  73
  74
  75 ///
  76 // Implement this structure to handle dialog events. The functions of this
  77 // structure will be called on the browser process UI thread.
  78 ///
  79 typedef struct _cef_dialog_handler_t {
  80   ///
  81   // Base structure.
  82   ///
  83   cef_base_ref_counted_t base;
  84
  85   ///
  86   // Called to run a file chooser dialog. |mode| represents the type of dialog
  87   // to display. |title| to the title to be used for the dialog and may be NULL
  88   // to show the default title ("Open" or "Save" depending on the mode).
  89   // |default_file_path| is the path with optional directory and/or file name
  90   // component that should be initially selected in the dialog. |accept_filters|
  91   // are used to restrict the selectable file types and may any combination of
  92   // (a) valid lower-cased MIME types (e.g. "text/*" or "image/*"), (b)
  93   // individual file extensions (e.g. ".txt" or ".png"), or (c) combined
  94   // description and file extension delimited using "|" and ";" (e.g. "Image
  95   // Types|.png;.gif;.jpg"). |selected_accept_filter| is the 0-based index of
  96   // the filter that should be selected by default. To display a custom dialog
  97   // return true (1) and execute |callback| either inline or at a later time. To
  98   // display the default dialog return false (0).
  99   ///
 100   int (CEF_CALLBACK *on_file_dialog)(struct _cef_dialog_handler_t* self,
 101       struct _cef_browser_t* browser, cef_file_dialog_mode_t mode,
 102       const cef_string_t* title, const cef_string_t* default_file_path,
 103       cef_string_list_t accept_filters, int selected_accept_filter,
 104       struct _cef_file_dialog_callback_t* callback);
 105 } cef_dialog_handler_t;
 106
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif
 111
 112 #endif  // CEF_INCLUDE_CAPI_CEF_DIALOG_HANDLER_CAPI_H_