git.sesse.net Git - casparcg/blob - dependencies64/cef/include/capi/cef_display_handler_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_DISPLAY_HANDLER_CAPI_H_
  38 #define CEF_INCLUDE_CAPI_CEF_DISPLAY_HANDLER_CAPI_H_
  39 #pragma once
  40
  41 #include "include/capi/cef_base_capi.h"
  42 #include "include/capi/cef_browser_capi.h"
  43 #include "include/capi/cef_frame_capi.h"
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49
  50 ///
  51 // Implement this structure to handle events related to browser display state.
  52 // The functions of this structure will be called on the UI thread.
  53 ///
  54 typedef struct _cef_display_handler_t {
  55   ///
  56   // Base structure.
  57   ///
  58   cef_base_t base;
  59
  60   ///
  61   // Called when a frame's address has changed.
  62   ///
  63   void (CEF_CALLBACK *on_address_change)(struct _cef_display_handler_t* self,
  64       struct _cef_browser_t* browser, struct _cef_frame_t* frame,
  65       const cef_string_t* url);
  66
  67   ///
  68   // Called when the page title changes.
  69   ///
  70   void (CEF_CALLBACK *on_title_change)(struct _cef_display_handler_t* self,
  71       struct _cef_browser_t* browser, const cef_string_t* title);
  72
  73   ///
  74   // Called when the page icon changes.
  75   ///
  76   void (CEF_CALLBACK *on_favicon_urlchange)(struct _cef_display_handler_t* self,
  77       struct _cef_browser_t* browser, cef_string_list_t icon_urls);
  78
  79   ///
  80   // Called when the browser is about to display a tooltip. |text| contains the
  81   // text that will be displayed in the tooltip. To handle the display of the
  82   // tooltip yourself return true (1). Otherwise, you can optionally modify
  83   // |text| and then return false (0) to allow the browser to display the
  84   // tooltip. When window rendering is disabled the application is responsible
  85   // for drawing tooltips and the return value is ignored.
  86   ///
  87   int (CEF_CALLBACK *on_tooltip)(struct _cef_display_handler_t* self,
  88       struct _cef_browser_t* browser, cef_string_t* text);
  89
  90   ///
  91   // Called when the browser receives a status message. |value| contains the
  92   // text that will be displayed in the status message.
  93   ///
  94   void (CEF_CALLBACK *on_status_message)(struct _cef_display_handler_t* self,
  95       struct _cef_browser_t* browser, const cef_string_t* value);
  96
  97   ///
  98   // Called to display a console message. Return true (1) to stop the message
  99   // from being output to the console.
 100   ///
 101   int (CEF_CALLBACK *on_console_message)(struct _cef_display_handler_t* self,
 102       struct _cef_browser_t* browser, const cef_string_t* message,
 103       const cef_string_t* source, int line);
 104 } cef_display_handler_t;
 105
 106
 107 #ifdef __cplusplus
 108 }
 109 #endif
 110
 111 #endif  // CEF_INCLUDE_CAPI_CEF_DISPLAY_HANDLER_CAPI_H_