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

   1 // Copyright (c) 2015 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_DRAG_DATA_CAPI_H_
  38 #define CEF_INCLUDE_CAPI_CEF_DRAG_DATA_CAPI_H_
  39 #pragma once
  40
  41 #include "include/capi/cef_base_capi.h"
  42 #include "include/capi/cef_stream_capi.h"
  43
  44 #ifdef __cplusplus
  45 extern "C" {
  46 #endif
  47
  48
  49 ///
  50 // Structure used to represent drag data. The functions of this structure may be
  51 // called on any thread.
  52 ///
  53 typedef struct _cef_drag_data_t {
  54   ///
  55   // Base structure.
  56   ///
  57   cef_base_t base;
  58
  59   ///
  60   // Returns a copy of the current object.
  61   ///
  62   struct _cef_drag_data_t* (CEF_CALLBACK *clone)(struct _cef_drag_data_t* self);
  63
  64   ///
  65   // Returns true (1) if this object is read-only.
  66   ///
  67   int (CEF_CALLBACK *is_read_only)(struct _cef_drag_data_t* self);
  68
  69   ///
  70   // Returns true (1) if the drag data is a link.
  71   ///
  72   int (CEF_CALLBACK *is_link)(struct _cef_drag_data_t* self);
  73
  74   ///
  75   // Returns true (1) if the drag data is a text or html fragment.
  76   ///
  77   int (CEF_CALLBACK *is_fragment)(struct _cef_drag_data_t* self);
  78
  79   ///
  80   // Returns true (1) if the drag data is a file.
  81   ///
  82   int (CEF_CALLBACK *is_file)(struct _cef_drag_data_t* self);
  83
  84   ///
  85   // Return the link URL that is being dragged.
  86   ///
  87   // The resulting string must be freed by calling cef_string_userfree_free().
  88   cef_string_userfree_t (CEF_CALLBACK *get_link_url)(
  89       struct _cef_drag_data_t* self);
  90
  91   ///
  92   // Return the title associated with the link being dragged.
  93   ///
  94   // The resulting string must be freed by calling cef_string_userfree_free().
  95   cef_string_userfree_t (CEF_CALLBACK *get_link_title)(
  96       struct _cef_drag_data_t* self);
  97
  98   ///
  99   // Return the metadata, if any, associated with the link being dragged.
 100   ///
 101   // The resulting string must be freed by calling cef_string_userfree_free().
 102   cef_string_userfree_t (CEF_CALLBACK *get_link_metadata)(
 103       struct _cef_drag_data_t* self);
 104
 105   ///
 106   // Return the plain text fragment that is being dragged.
 107   ///
 108   // The resulting string must be freed by calling cef_string_userfree_free().
 109   cef_string_userfree_t (CEF_CALLBACK *get_fragment_text)(
 110       struct _cef_drag_data_t* self);
 111
 112   ///
 113   // Return the text/html fragment that is being dragged.
 114   ///
 115   // The resulting string must be freed by calling cef_string_userfree_free().
 116   cef_string_userfree_t (CEF_CALLBACK *get_fragment_html)(
 117       struct _cef_drag_data_t* self);
 118
 119   ///
 120   // Return the base URL that the fragment came from. This value is used for
 121   // resolving relative URLs and may be NULL.
 122   ///
 123   // The resulting string must be freed by calling cef_string_userfree_free().
 124   cef_string_userfree_t (CEF_CALLBACK *get_fragment_base_url)(
 125       struct _cef_drag_data_t* self);
 126
 127   ///
 128   // Return the name of the file being dragged out of the browser window.
 129   ///
 130   // The resulting string must be freed by calling cef_string_userfree_free().
 131   cef_string_userfree_t (CEF_CALLBACK *get_file_name)(
 132       struct _cef_drag_data_t* self);
 133
 134   ///
 135   // Write the contents of the file being dragged out of the web view into
 136   // |writer|. Returns the number of bytes sent to |writer|. If |writer| is NULL
 137   // this function will return the size of the file contents in bytes. Call
 138   // get_file_name() to get a suggested name for the file.
 139   ///
 140   size_t (CEF_CALLBACK *get_file_contents)(struct _cef_drag_data_t* self,
 141       struct _cef_stream_writer_t* writer);
 142
 143   ///
 144   // Retrieve the list of file names that are being dragged into the browser
 145   // window.
 146   ///
 147   int (CEF_CALLBACK *get_file_names)(struct _cef_drag_data_t* self,
 148       cef_string_list_t names);
 149
 150   ///
 151   // Set the link URL that is being dragged.
 152   ///
 153   void (CEF_CALLBACK *set_link_url)(struct _cef_drag_data_t* self,
 154       const cef_string_t* url);
 155
 156   ///
 157   // Set the title associated with the link being dragged.
 158   ///
 159   void (CEF_CALLBACK *set_link_title)(struct _cef_drag_data_t* self,
 160       const cef_string_t* title);
 161
 162   ///
 163   // Set the metadata associated with the link being dragged.
 164   ///
 165   void (CEF_CALLBACK *set_link_metadata)(struct _cef_drag_data_t* self,
 166       const cef_string_t* data);
 167
 168   ///
 169   // Set the plain text fragment that is being dragged.
 170   ///
 171   void (CEF_CALLBACK *set_fragment_text)(struct _cef_drag_data_t* self,
 172       const cef_string_t* text);
 173
 174   ///
 175   // Set the text/html fragment that is being dragged.
 176   ///
 177   void (CEF_CALLBACK *set_fragment_html)(struct _cef_drag_data_t* self,
 178       const cef_string_t* html);
 179
 180   ///
 181   // Set the base URL that the fragment came from.
 182   ///
 183   void (CEF_CALLBACK *set_fragment_base_url)(struct _cef_drag_data_t* self,
 184       const cef_string_t* base_url);
 185
 186   ///
 187   // Reset the file contents. You should do this before calling
 188   // cef_browser_host_t::DragTargetDragEnter as the web view does not allow us
 189   // to drag in this kind of data.
 190   ///
 191   void (CEF_CALLBACK *reset_file_contents)(struct _cef_drag_data_t* self);
 192
 193   ///
 194   // Add a file that is being dragged into the webview.
 195   ///
 196   void (CEF_CALLBACK *add_file)(struct _cef_drag_data_t* self,
 197       const cef_string_t* path, const cef_string_t* display_name);
 198 } cef_drag_data_t;
 199
 200
 201 ///
 202 // Create a new cef_drag_data_t object.
 203 ///
 204 CEF_EXPORT cef_drag_data_t* cef_drag_data_create();
 205
 206
 207 #ifdef __cplusplus
 208 }
 209 #endif
 210
 211 #endif  // CEF_INCLUDE_CAPI_CEF_DRAG_DATA_CAPI_H_