git.sesse.net Git - casparcg/blob - dependencies64/cef/include/capi/cef_navigation_entry_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_NAVIGATION_ENTRY_CAPI_H_
  38 #define CEF_INCLUDE_CAPI_CEF_NAVIGATION_ENTRY_CAPI_H_
  39 #pragma once
  40
  41 #include "include/capi/cef_base_capi.h"
  42
  43 #ifdef __cplusplus
  44 extern "C" {
  45 #endif
  46
  47
  48 ///
  49 // Structure used to represent an entry in navigation history.
  50 ///
  51 typedef struct _cef_navigation_entry_t {
  52   ///
  53   // Base structure.
  54   ///
  55   cef_base_t base;
  56
  57   ///
  58   // Returns true (1) if this object is valid. Do not call any other functions
  59   // if this function returns false (0).
  60   ///
  61   int (CEF_CALLBACK *is_valid)(struct _cef_navigation_entry_t* self);
  62
  63   ///
  64   // Returns the actual URL of the page. For some pages this may be data: URL or
  65   // similar. Use get_display_url() to return a display-friendly version.
  66   ///
  67   // The resulting string must be freed by calling cef_string_userfree_free().
  68   cef_string_userfree_t (CEF_CALLBACK *get_url)(
  69       struct _cef_navigation_entry_t* self);
  70
  71   ///
  72   // Returns a display-friendly version of the URL.
  73   ///
  74   // The resulting string must be freed by calling cef_string_userfree_free().
  75   cef_string_userfree_t (CEF_CALLBACK *get_display_url)(
  76       struct _cef_navigation_entry_t* self);
  77
  78   ///
  79   // Returns the original URL that was entered by the user before any redirects.
  80   ///
  81   // The resulting string must be freed by calling cef_string_userfree_free().
  82   cef_string_userfree_t (CEF_CALLBACK *get_original_url)(
  83       struct _cef_navigation_entry_t* self);
  84
  85   ///
  86   // Returns the title set by the page. This value may be NULL.
  87   ///
  88   // The resulting string must be freed by calling cef_string_userfree_free().
  89   cef_string_userfree_t (CEF_CALLBACK *get_title)(
  90       struct _cef_navigation_entry_t* self);
  91
  92   ///
  93   // Returns the transition type which indicates what the user did to move to
  94   // this page from the previous page.
  95   ///
  96   cef_transition_type_t (CEF_CALLBACK *get_transition_type)(
  97       struct _cef_navigation_entry_t* self);
  98
  99   ///
 100   // Returns true (1) if this navigation includes post data.
 101   ///
 102   int (CEF_CALLBACK *has_post_data)(struct _cef_navigation_entry_t* self);
 103
 104   ///
 105   // Returns the name of the sub-frame that navigated or an NULL value if the
 106   // main frame navigated.
 107   ///
 108   // The resulting string must be freed by calling cef_string_userfree_free().
 109   cef_string_userfree_t (CEF_CALLBACK *get_frame_name)(
 110       struct _cef_navigation_entry_t* self);
 111
 112   ///
 113   // Returns the time for the last known successful navigation completion. A
 114   // navigation may be completed more than once if the page is reloaded. May be
 115   // 0 if the navigation has not yet completed.
 116   ///
 117   cef_time_t (CEF_CALLBACK *get_completion_time)(
 118       struct _cef_navigation_entry_t* self);
 119
 120   ///
 121   // Returns the HTTP status code for the last known successful navigation
 122   // response. May be 0 if the response has not yet been received or if the
 123   // navigation has not yet completed.
 124   ///
 125   int (CEF_CALLBACK *get_http_status_code)(
 126       struct _cef_navigation_entry_t* self);
 127 } cef_navigation_entry_t;
 128
 129
 130 #ifdef __cplusplus
 131 }
 132 #endif
 133
 134 #endif  // CEF_INCLUDE_CAPI_CEF_NAVIGATION_ENTRY_CAPI_H_