git.sesse.net Git - casparcg/blob - dependencies64/cef/include/capi/cef_load_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_LOAD_HANDLER_CAPI_H_
  38 #define CEF_INCLUDE_CAPI_CEF_LOAD_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 load status. The
  52 // functions of this structure will be called on the browser process UI thread
  53 // or render process main thread (TID_RENDERER).
  54 ///
  55 typedef struct _cef_load_handler_t {
  56   ///
  57   // Base structure.
  58   ///
  59   cef_base_t base;
  60
  61   ///
  62   // Called when the loading state has changed. This callback will be executed
  63   // twice -- once when loading is initiated either programmatically or by user
  64   // action, and once when loading is terminated due to completion, cancellation
  65   // of failure.
  66   ///
  67   void (CEF_CALLBACK *on_loading_state_change)(struct _cef_load_handler_t* self,
  68       struct _cef_browser_t* browser, int isLoading, int canGoBack,
  69       int canGoForward);
  70
  71   ///
  72   // Called when the browser begins loading a frame. The |frame| value will
  73   // never be NULL -- call the is_main() function to check if this frame is the
  74   // main frame. Multiple frames may be loading at the same time. Sub-frames may
  75   // start or continue loading after the main frame load has ended. This
  76   // function may not be called for a particular frame if the load request for
  77   // that frame fails. For notification of overall browser load status use
  78   // OnLoadingStateChange instead.
  79   ///
  80   void (CEF_CALLBACK *on_load_start)(struct _cef_load_handler_t* self,
  81       struct _cef_browser_t* browser, struct _cef_frame_t* frame);
  82
  83   ///
  84   // Called when the browser is done loading a frame. The |frame| value will
  85   // never be NULL -- call the is_main() function to check if this frame is the
  86   // main frame. Multiple frames may be loading at the same time. Sub-frames may
  87   // start or continue loading after the main frame load has ended. This
  88   // function will always be called for all frames irrespective of whether the
  89   // request completes successfully.
  90   ///
  91   void (CEF_CALLBACK *on_load_end)(struct _cef_load_handler_t* self,
  92       struct _cef_browser_t* browser, struct _cef_frame_t* frame,
  93       int httpStatusCode);
  94
  95   ///
  96   // Called when the resource load for a navigation fails or is canceled.
  97   // |errorCode| is the error code number, |errorText| is the error text and
  98   // |failedUrl| is the URL that failed to load. See net\base\net_error_list.h
  99   // for complete descriptions of the error codes.
 100   ///
 101   void (CEF_CALLBACK *on_load_error)(struct _cef_load_handler_t* self,
 102       struct _cef_browser_t* browser, struct _cef_frame_t* frame,
 103       cef_errorcode_t errorCode, const cef_string_t* errorText,
 104       const cef_string_t* failedUrl);
 105 } cef_load_handler_t;
 106
 107
 108 #ifdef __cplusplus
 109 }
 110 #endif
 111
 112 #endif  // CEF_INCLUDE_CAPI_CEF_LOAD_HANDLER_CAPI_H_