- Generated by
1.9.1
|
Chromium Embedded Framework (CEF)
114.2.1+gd70a0a8+chromium-114.0.5735.45
|
#include "include/base/cef_basictypes.h"#include "include/internal/cef_string.h"#include "include/internal/cef_string_list.h"#include "include/internal/cef_time.h"#include "include/internal/cef_types_geometry.h"#include "include/internal/cef_types_win.h"#include "include/base/internal/cef_net_error_list.h"Classes | |
| struct | cef_settings_t |
| Initialization settings. More... | |
| struct | cef_request_context_settings_t |
| Request context initialization settings. More... | |
| struct | cef_browser_settings_t |
| Browser initialization settings. More... | |
| struct | cef_urlparts_t |
| URL component parts. More... | |
| struct | cef_cookie_t |
| Cookie information. More... | |
| struct | cef_draggable_region_t |
| Structure representing a draggable region. More... | |
| struct | cef_screen_info_t |
| Screen information used when window rendering is disabled. More... | |
| struct | cef_mouse_event_t |
| Structure representing mouse event information. More... | |
| struct | cef_touch_event_t |
| Structure representing touch event information. More... | |
| struct | cef_key_event_t |
| Structure representing keyboard event information. More... | |
| struct | cef_popup_features_t |
| Popup window features. More... | |
| struct | cef_cursor_info_t |
| Structure representing cursor information. More... | |
| struct | cef_pdf_print_settings_t |
| Structure representing PDF print settings. More... | |
| struct | cef_box_layout_settings_t |
| Settings used when initializing a CefBoxLayout. More... | |
| struct | cef_range_t |
| Structure representing a range. More... | |
| struct | cef_composition_underline_t |
| Structure representing IME composition underline information. More... | |
| struct | cef_audio_parameters_t |
| Structure representing the audio parameters for setting up the audio handler. More... | |
| struct | cef_media_sink_device_info_t |
| Device information for a MediaSink object. More... | |
| struct | cef_touch_handle_state_t |
Macros | |
| #define | CefColorGetA(color) (((color) >> 24) & 0xFF) |
| #define | CefColorGetR(color) (((color) >> 16) & 0xFF) |
| #define | CefColorGetG(color) (((color) >> 8) & 0xFF) |
| #define | CefColorGetB(color) (((color) >> 0) & 0xFF) |
| #define | CefColorSetARGB(a, r, g, b) |
| #define | CefInt64Set(int32_low, int32_high) |
| #define | CefInt64GetLow(int64_val) static_cast<int32>(int64_val) |
| #define | CefInt64GetHigh(int64_val) static_cast<int32>((static_cast<int64>(int64_val) >> 32) & 0xFFFFFFFFL) |
| #define | NET_ERROR(label, value) ERR_##label = value, |
Typedefs | |
| typedef uint32 | cef_color_t |
| #define CefColorGetA | ( | color | ) | (((color) >> 24) & 0xFF) |
| #define CefColorGetB | ( | color | ) | (((color) >> 0) & 0xFF) |
| #define CefColorGetG | ( | color | ) | (((color) >> 8) & 0xFF) |
| #define CefColorGetR | ( | color | ) | (((color) >> 16) & 0xFF) |
| #define CefColorSetARGB | ( | a, | |
| r, | |||
| g, | |||
| b | |||
| ) |
| #define CefInt64GetHigh | ( | int64_val | ) | static_cast<int32>((static_cast<int64>(int64_val) >> 32) & 0xFFFFFFFFL) |
| #define CefInt64GetLow | ( | int64_val | ) | static_cast<int32>(int64_val) |
| #define CefInt64Set | ( | int32_low, | |
| int32_high | |||
| ) |
| #define NET_ERROR | ( | label, | |
| value | |||
| ) | ERR_##label = value, |
| typedef uint32 cef_color_t |
| enum cef_alpha_type_t |
| enum cef_button_state_t |
| enum cef_cert_status_t |
Supported certificate status code values.
See net\cert\cert_status_flags.h for more information. CERT_STATUS_NONE is new in CEF because we use an enum while cert_status_flags.h uses a typedef and static const variables.
| enum cef_channel_layout_t |
Enumerates the various representations of the ordering of audio channels.
Must be kept synchronized with media::ChannelLayout from Chromium. See media\base\channel_layout.h
Chrome page action icon types.
Should be kept in sync with Chromium's PageActionIconType type.
| enum cef_color_model_t |
Print job color mode values.
| enum cef_color_type_t |
| enum cef_com_init_mode_t |
Supported context menu edit state bit flags.
These constants match their equivalents in Chromium's ContextMenuDataEditFlags and should not be renumbered.
Supported context menu media state bit flags.
These constants match their equivalents in Chromium's ContextMenuData::MediaFlags and should not be renumbered.
Supported context menu media types.
These constants match their equivalents in Chromium's ContextMenuDataMediaType and should not be renumbered.
Supported context menu type flags.
Specifies where along the cross axis the CefBoxLayout child views should be laid out.
| enum cef_cursor_type_t |
Cursor type values.
| enum cef_docking_mode_t |
DOM event category flags.
| enum cef_dom_node_type_t |
Download interrupt reasons.
Should be kept in sync with Chromium's download::DownloadInterruptReason type.
"Verb" of a drag-and-drop operation as negotiated between the source and destination.
These constants match their equivalents in WebCore's DragActions.h and should not be renumbered.
| Enumerator | |
|---|---|
| DRAG_OPERATION_NONE | |
| DRAG_OPERATION_COPY | |
| DRAG_OPERATION_LINK | |
| DRAG_OPERATION_GENERIC | |
| DRAG_OPERATION_PRIVATE | |
| DRAG_OPERATION_MOVE | |
| DRAG_OPERATION_DELETE | |
| DRAG_OPERATION_EVERY | |
| enum cef_duplex_mode_t |
| enum cef_errorcode_t |
| enum cef_event_flags_t |
Supported event bit flags.
Supported file dialog modes.
| enum cef_focus_source_t |
Specifies the horizontal text alignment mode.
| enum cef_jsdialog_type_t |
Options that can be passed to CefParseJSON.
Options that can be passed to CefWriteJSON.
| enum cef_key_event_type_t |
Key event types.
| enum cef_log_severity_t |
Log severity levels.
Specifies where along the main axis the CefBoxLayout child views should be laid out.
Media access permissions used by OnRequestMediaAccessPermission.
Result codes for CefMediaRouter::CreateRoute.
Should be kept in sync with Chromium's media_router::mojom::RouteRequestResultCode type.
| enum cef_menu_id_t |
Supported menu IDs.
Non-English translations can be provided for the IDS_MENU_* strings in CefResourceBundleHandler::GetLocalizedString().
| enum cef_menu_item_type_t |
| enum cef_path_key_t |
Path key values.
Margin type for PDF printing.
| Enumerator | |
|---|---|
| PDF_PRINT_MARGIN_DEFAULT | Default margins of 1cm (~0.4 inches). |
| PDF_PRINT_MARGIN_NONE | No margins. |
| PDF_PRINT_MARGIN_CUSTOM | Custom margins using the |margin_*| values from cef_pdf_print_settings_t. |
Permission request results.
Permission types used with OnShowPermissionPrompt.
Some types are platform-specific or only supported with the Chrome runtime. Should be kept in sync with Chromium's permissions::RequestType type.
| enum cef_pointer_type_t |
Preferences type passed to CefBrowserProcessHandler::OnRegisterCustomPreferences.
| Enumerator | |
|---|---|
| CEF_PREFERENCES_TYPE_GLOBAL | Global preferences registered a single time at application startup. |
| CEF_PREFERENCES_TYPE_REQUEST_CONTEXT | Request context preferences registered each time a new CefRequestContext is created. |
| enum cef_process_id_t |
Policy for how the Referrer HTTP header value will be sent during navigation.
If the --no-referrers command-line flag is specified then the policy value will be ignored and the Referrer value will never be sent. Must be kept synchronized with net::URLRequest::ReferrerPolicy from Chromium.
| enum cef_resource_type_t |
Resource type for a request.
These constants match their equivalents in Chromium's ResourceType and should not be renumbered.
Return values for CefResponseFilter::Filter().
| enum cef_return_value_t |
| enum cef_scale_factor_t |
Supported UI scale factors for the platform.
SCALE_FACTOR_NONE is used for density independent resources such as string, html/js files or an image that can be used for any scale factors (such as wallpapers).
| Enumerator | |
|---|---|
| SCALE_FACTOR_NONE | |
| SCALE_FACTOR_100P | |
| SCALE_FACTOR_125P | |
| SCALE_FACTOR_133P | |
| SCALE_FACTOR_140P | |
| SCALE_FACTOR_150P | |
| SCALE_FACTOR_180P | |
| SCALE_FACTOR_200P | |
| SCALE_FACTOR_250P | |
| SCALE_FACTOR_300P | |
| enum cef_scheme_options_t |
Configuration options for registering a custom scheme.
These values are used when calling AddCustomScheme.
| Enumerator | |
|---|---|
| CEF_SCHEME_OPTION_NONE | |
| CEF_SCHEME_OPTION_STANDARD | If CEF_SCHEME_OPTION_STANDARD is set the scheme will be treated as a standard scheme. Standard schemes are subject to URL canonicalization and parsing rules as defined in the Common Internet Scheme Syntax RFC 1738 Section 3.1 available at http://www.ietf.org/rfc/rfc1738.txt In particular, the syntax for standard scheme URLs must be of the form: [scheme]://[username]:[password]@[host]:[port]/[url-path] Standard scheme URLs must have a host component that is a fully qualified domain name as defined in Section 3.5 of RFC 1034 [13] and Section 2.1 of RFC 1123. These URLs will be canonicalized to "scheme://host/path" in the simplest case and "scheme://username:password@host:port/path" in the most explicit case. For example, "scheme:host/path" and "scheme:///host/path" will both be canonicalized to "scheme://host/path". The origin of a standard scheme URL is the combination of scheme, host and port (i.e., "scheme://host:port" in the most explicit case). For non-standard scheme URLs only the "scheme:" component is parsed and canonicalized. The remainder of the URL will be passed to the handler as- is. For example, "scheme:///some%20text" will remain the same. Non-standard scheme URLs cannot be used as a target for form submission. |
| CEF_SCHEME_OPTION_LOCAL | If CEF_SCHEME_OPTION_LOCAL is set the scheme will be treated with the same security rules as those applied to "file" URLs. Normal pages cannot link to or access local URLs. Also, by default, local URLs can only perform XMLHttpRequest calls to the same URL (origin + path) that originated the request. To allow XMLHttpRequest calls from a local URL to other URLs with the same origin set the CefSettings.file_access_from_file_urls_allowed value to true (1). To allow XMLHttpRequest calls from a local URL to all origins set the CefSettings.universal_access_from_file_urls_allowed value to true (1). |
| CEF_SCHEME_OPTION_DISPLAY_ISOLATED | If CEF_SCHEME_OPTION_DISPLAY_ISOLATED is set the scheme can only be displayed from other content hosted with the same scheme. For example, pages in other origins cannot create iframes or hyperlinks to URLs with the scheme. For schemes that must be accessible from other schemes don't set this, set CEF_SCHEME_OPTION_CORS_ENABLED, and use CORS "Access-Control-Allow-Origin" headers to further restrict access. |
| CEF_SCHEME_OPTION_SECURE | If CEF_SCHEME_OPTION_SECURE is set the scheme will be treated with the same security rules as those applied to "https" URLs. For example, loading this scheme from other secure schemes will not trigger mixed content warnings. |
| CEF_SCHEME_OPTION_CORS_ENABLED | If CEF_SCHEME_OPTION_CORS_ENABLED is set the scheme can be sent CORS requests. This value should be set in most cases where CEF_SCHEME_OPTION_STANDARD is set. |
| CEF_SCHEME_OPTION_CSP_BYPASSING | If CEF_SCHEME_OPTION_CSP_BYPASSING is set the scheme can bypass Content- Security-Policy (CSP) checks. This value should not be set in most cases where CEF_SCHEME_OPTION_STANDARD is set. |
| CEF_SCHEME_OPTION_FETCH_ENABLED | If CEF_SCHEME_OPTION_FETCH_ENABLED is set the scheme can perform Fetch API requests. |
| enum cef_show_state_t |
Show states supported by CefWindowDelegate::GetInitialShowState.
| Enumerator | |
|---|---|
| CEF_SHOW_STATE_NORMAL | |
| CEF_SHOW_STATE_MINIMIZED | |
| CEF_SHOW_STATE_MAXIMIZED | |
| CEF_SHOW_STATE_FULLSCREEN | |
| enum cef_ssl_version_t |
Supported SSL version values.
See net/ssl/ssl_connection_status_flags.h for more information.
| enum cef_state_t |
| enum cef_storage_type_t |
| enum cef_test_cert_type_t |
Certificate types supported by CefTestServer::CreateAndStart.
The matching certificate file must exist in the "net/data/ssl/certificates" directory. See CefSetDataDirectoryForTests() for related configuration.
Input mode of a virtual keyboard.
These constants match their equivalents in Chromium's text_input_mode.h and should not be renumbered. See https://html.spec.whatwg.org/#input-modalities:-the-inputmode-attribute
| enum cef_text_style_t |
| enum cef_thread_id_t |
Existing thread IDs.
| Enumerator | |
|---|---|
| TID_UI | The main thread in the browser. This will be the same as the main application thread if CefInitialize() is called with a CefSettings.multi_threaded_message_loop value of false. Do not perform blocking tasks on this thread. All tasks posted after CefBrowserProcessHandler::OnContextInitialized() and before CefShutdown() are guaranteed to run. This thread will outlive all other CEF threads. |
| TID_FILE_BACKGROUND | Used for blocking tasks like file system access where the user won't notice if the task takes an arbitrarily long time to complete. All tasks posted after CefBrowserProcessHandler::OnContextInitialized() and before CefShutdown() are guaranteed to run. |
| TID_FILE_USER_VISIBLE | Used for blocking tasks like file system access that affect UI or responsiveness of future user interactions. Do not use if an immediate response to a user interaction is expected. All tasks posted after CefBrowserProcessHandler::OnContextInitialized() and before CefShutdown() are guaranteed to run. Examples:
|
| TID_FILE_USER_BLOCKING | Used for blocking tasks like file system access that affect UI immediately after a user interaction. All tasks posted after CefBrowserProcessHandler::OnContextInitialized() and before CefShutdown() are guaranteed to run. Example: Generating data shown in the UI immediately after a click. |
| TID_PROCESS_LAUNCHER | Used to launch and terminate browser processes. |
| TID_IO | Used to process IPC and network messages. Do not perform blocking tasks on this thread. All tasks posted after CefBrowserProcessHandler::OnContextInitialized() and before CefShutdown() are guaranteed to run. |
| TID_RENDERER | The main thread in the renderer. Used for all WebKit and V8 interaction. Tasks may be posted to this thread after CefRenderProcessHandler::OnWebKitInitialized but are not guaranteed to run before sub-process termination (sub-processes may be killed at any time without warning). |
Thread priority values listed in increasing order of importance.
Transition type for a request.
Made up of one source value and 0 or more qualifiers.
| Enumerator | |
|---|---|
| TT_LINK | Source is a link click or the JavaScript window.open function. This is also the default value for requests like sub-resource loads that are not navigations. |
| TT_EXPLICIT | Source is some other "explicit" navigation. This is the default value for navigations where the actual type is unknown. See also TT_DIRECT_LOAD_FLAG. |
| TT_AUTO_BOOKMARK | User got to this page through a suggestion in the UI (for example, via the destinations page). Chrome runtime only. |
| TT_AUTO_SUBFRAME | Source is a subframe navigation. This is any content that is automatically loaded in a non-toplevel frame. For example, if a page consists of several frames containing ads, those ad URLs will have this transition type. The user may not even realize the content in these pages is a separate frame, so may not care about the URL. |
| TT_MANUAL_SUBFRAME | Source is a subframe navigation explicitly requested by the user that will generate new navigation entries in the back/forward list. These are probably more important than frames that were automatically loaded in the background because the user probably cares about the fact that this link was loaded. |
| TT_GENERATED | User got to this page by typing in the URL bar and selecting an entry that did not look like a URL. For example, a match might have the URL of a Google search result page, but appear like "Search Google for ...". These are not quite the same as EXPLICIT navigations because the user didn't type or see the destination URL. Chrome runtime only. See also TT_KEYWORD. |
| TT_AUTO_TOPLEVEL | This is a toplevel navigation. This is any content that is automatically loaded in a toplevel frame. For example, opening a tab to show the ASH screen saver, opening the devtools window, opening the NTP after the safe browsing warning, opening web-based dialog boxes are examples of AUTO_TOPLEVEL navigations. Chrome runtime only. |
| TT_FORM_SUBMIT | Source is a form submission by the user. NOTE: In some situations submitting a form does not result in this transition type. This can happen if the form uses a script to submit the contents. |
| TT_RELOAD | Source is a "reload" of the page via the Reload function or by re-visiting the same URL. NOTE: This is distinct from the concept of whether a particular load uses "reload semantics" (i.e. bypasses cached data). |
| TT_KEYWORD | The url was generated from a replaceable keyword other than the default search provider. If the user types a keyword (which also applies to tab-to-search) in the omnibox this qualifier is applied to the transition type of the generated url. TemplateURLModel then may generate an additional visit with a transition type of TT_KEYWORD_GENERATED against the url 'http://' + keyword. For example, if you do a tab-to-search against wikipedia the generated url has a transition qualifer of TT_KEYWORD, and TemplateURLModel generates a visit for 'wikipedia.org' with a transition type of TT_KEYWORD_GENERATED. Chrome runtime only. |
| TT_KEYWORD_GENERATED | Corresponds to a visit generated for a keyword. See description of TT_KEYWORD for more details. Chrome runtime only. |
| TT_SOURCE_MASK | General mask defining the bits used for the source values. |
| TT_BLOCKED_FLAG | Qualifiers. Any of the core values above can be augmented by one or more qualifiers. These qualifiers further define the transition. Attempted to visit a URL but was blocked. |
| TT_FORWARD_BACK_FLAG | Used the Forward or Back function to navigate among browsing history. Will be ORed to the transition type for the original load. |
| TT_DIRECT_LOAD_FLAG | Loaded a URL directly via CreateBrowser, LoadURL or LoadRequest. |
| TT_HOME_PAGE_FLAG | User is navigating to the home page. Chrome runtime only. |
| TT_FROM_API_FLAG | The transition originated from an external application; the exact definition of this is embedder dependent. Chrome runtime and extension system only. |
| TT_CHAIN_START_FLAG | The beginning of a navigation chain. |
| TT_CHAIN_END_FLAG | The last transition in a redirect chain. |
| TT_CLIENT_REDIRECT_FLAG | Redirects caused by JavaScript or a meta refresh tag on the page. |
| TT_SERVER_REDIRECT_FLAG | Redirects sent from the server by HTTP headers. |
| TT_IS_REDIRECT_MASK | Used to test whether a transition involves a redirect. |
| TT_QUALIFIER_MASK | General mask defining the bits used for the qualifiers. |
URI unescape rules passed to CefURIDecode().
Flags used to customize the behavior of CefURLRequest.
| Enumerator | |
|---|---|
| UR_FLAG_NONE | Default behavior. |
| UR_FLAG_SKIP_CACHE | If set the cache will be skipped when handling the request. Setting this value is equivalent to specifying the "Cache-Control: no-cache" request header. Setting this value in combination with UR_FLAG_ONLY_FROM_CACHE will cause the request to fail. |
| UR_FLAG_ONLY_FROM_CACHE | If set the request will fail if it cannot be served from the cache (or some equivalent local store). Setting this value is equivalent to specifying the "Cache-Control: only-if-cached" request header. Setting this value in combination with UR_FLAG_SKIP_CACHE or UR_FLAG_DISABLE_CACHE will cause the request to fail. |
| UR_FLAG_DISABLE_CACHE | If set the cache will not be used at all. Setting this value is equivalent to specifying the "Cache-Control: no-store" request header. Setting this value in combination with UR_FLAG_ONLY_FROM_CACHE will cause the request to fail. |
| UR_FLAG_ALLOW_STORED_CREDENTIALS | If set user name, password, and cookies may be sent with the request, and cookies may be saved from the response. |
| UR_FLAG_REPORT_UPLOAD_PROGRESS | If set upload progress events will be generated when a request has a body. |
| UR_FLAG_NO_DOWNLOAD_DATA | If set the CefURLRequestClient::OnDownloadData method will not be called. |
| UR_FLAG_NO_RETRY_ON_5XX | If set 5XX redirect errors will be propagated to the observer instead of automatically re-tried. This currently only applies for requests originated in the browser process. |
| UR_FLAG_STOP_ON_REDIRECT | If set 3XX responses will cause the fetch to halt immediately rather than continue through the redirect. |
Flags that represent CefURLRequest status.
| enum cef_value_type_t |
The manner in which a link click should be opened.
These constants match their equivalents in Chromium's window_open_disposition.h and should not be renumbered.
Supported XML encoding types.
The parser supports ASCII, ISO-8859-1, and UTF16 (LE and BE) by default. All other types must be translated to UTF8 before being passed to the parser. If a BOM is detected and the correct decoder is available then that decoder will be used automatically.
| Enumerator | |
|---|---|
| XML_ENCODING_NONE | |
| XML_ENCODING_UTF8 | |
| XML_ENCODING_UTF16LE | |
| XML_ENCODING_UTF16BE | |
| XML_ENCODING_ASCII | |
| enum cef_xml_node_type_t |
1.9.1