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