diff --git a/include/capi/cef_accessibility_handler_capi.h b/include/capi/cef_accessibility_handler_capi.h index cafa9a27d..5eb40d84f 100644 --- a/include/capi/cef_accessibility_handler_capi.h +++ b/include/capi/cef_accessibility_handler_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=306e44d49ab6198a0fa1bcea50e8a25ee18672be$ +// $hash=6bdc0ce413420b45510fcc7f415c6a6fb05f0112$ // #ifndef CEF_INCLUDE_CAPI_CEF_ACCESSIBILITY_HANDLER_CAPI_H_ @@ -47,27 +47,27 @@ extern "C" { #endif /// -// Implement this structure to receive accessibility notification when -// accessibility events have been registered. The functions of this structure -// will be called on the UI thread. +/// Implement this structure to receive accessibility notification when +/// accessibility events have been registered. The functions of this structure +/// will be called on the UI thread. /// typedef struct _cef_accessibility_handler_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called after renderer process sends accessibility tree changes to the - // browser process. + /// Called after renderer process sends accessibility tree changes to the + /// browser process. /// void(CEF_CALLBACK* on_accessibility_tree_change)( struct _cef_accessibility_handler_t* self, struct _cef_value_t* value); /// - // Called after renderer process sends accessibility location changes to the - // browser process. + /// Called after renderer process sends accessibility location changes to the + /// browser process. /// void(CEF_CALLBACK* on_accessibility_location_change)( struct _cef_accessibility_handler_t* self, diff --git a/include/capi/cef_app_capi.h b/include/capi/cef_app_capi.h index 2a355262d..85ed8e115 100644 --- a/include/capi/cef_app_capi.h +++ b/include/capi/cef_app_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=84440a43cf4be6728b51919e65c5f33e5736c502$ +// $hash=7c6894aae3e508aaa42a376532328316d9bd509c$ // #ifndef CEF_INCLUDE_CAPI_CEF_APP_CAPI_H_ @@ -54,25 +54,26 @@ extern "C" { struct _cef_app_t; /// -// Implement this structure to provide handler implementations. Methods will be -// called by the process and/or thread indicated. +/// Implement this structure to provide handler implementations. Methods will be +/// called by the process and/or thread indicated. /// typedef struct _cef_app_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Provides an opportunity to view and/or modify command-line arguments before - // processing by CEF and Chromium. The |process_type| value will be NULL for - // the browser process. Do not keep a reference to the cef_command_line_t - // object passed to this function. The CefSettings.command_line_args_disabled - // value can be used to start with an NULL command-line object. Any values - // specified in CefSettings that equate to command-line arguments will be set - // before this function is called. Be cautious when using this function to - // modify command-line arguments for non-browser processes as this may result - // in undefined behavior including crashes. + /// Provides an opportunity to view and/or modify command-line arguments + /// before processing by CEF and Chromium. The |process_type| value will be + /// NULL for the browser process. Do not keep a reference to the + /// cef_command_line_t object passed to this function. The + /// cef_settings_t.command_line_args_disabled value can be used to start with + /// an NULL command-line object. Any values specified in CefSettings that + /// equate to command-line arguments will be set before this function is + /// called. Be cautious when using this function to modify command-line + /// arguments for non-browser processes as this may result in undefined + /// behavior including crashes. /// void(CEF_CALLBACK* on_before_command_line_processing)( struct _cef_app_t* self, @@ -80,61 +81,62 @@ typedef struct _cef_app_t { struct _cef_command_line_t* command_line); /// - // Provides an opportunity to register custom schemes. Do not keep a reference - // to the |registrar| object. This function is called on the main thread for - // each process and the registered schemes should be the same across all - // processes. + /// Provides an opportunity to register custom schemes. Do not keep a + /// reference to the |registrar| object. This function is called on the main + /// thread for each process and the registered schemes should be the same + /// across all processes. /// void(CEF_CALLBACK* on_register_custom_schemes)( struct _cef_app_t* self, struct _cef_scheme_registrar_t* registrar); /// - // Return the handler for resource bundle events. If - // CefSettings.pack_loading_disabled is true (1) a handler must be returned. - // If no handler is returned resources will be loaded from pack files. This - // function is called by the browser and render processes on multiple threads. + /// Return the handler for resource bundle events. If + /// cef_settings_t.pack_loading_disabled is true (1) a handler must be + /// returned. If no handler is returned resources will be loaded from pack + /// files. This function is called by the browser and render processes on + /// multiple threads. /// struct _cef_resource_bundle_handler_t*( CEF_CALLBACK* get_resource_bundle_handler)(struct _cef_app_t* self); /// - // Return the handler for functionality specific to the browser process. This - // function is called on multiple threads in the browser process. + /// Return the handler for functionality specific to the browser process. This + /// function is called on multiple threads in the browser process. /// struct _cef_browser_process_handler_t*( CEF_CALLBACK* get_browser_process_handler)(struct _cef_app_t* self); /// - // Return the handler for functionality specific to the render process. This - // function is called on the render process main thread. + /// Return the handler for functionality specific to the render process. This + /// function is called on the render process main thread. /// struct _cef_render_process_handler_t*( CEF_CALLBACK* get_render_process_handler)(struct _cef_app_t* self); } cef_app_t; /// -// This function should be called from the application entry point function to -// execute a secondary process. It can be used to run secondary processes from -// the browser client executable (default behavior) or from a separate -// executable specified by the CefSettings.browser_subprocess_path value. If -// called for the browser process (identified by no "type" command-line value) -// it will return immediately with a value of -1. If called for a recognized -// secondary process it will block until the process should exit and then return -// the process exit code. The |application| parameter may be NULL. The -// |windows_sandbox_info| parameter is only used on Windows and may be NULL (see -// cef_sandbox_win.h for details). +/// This function should be called from the application entry point function to +/// execute a secondary process. It can be used to run secondary processes from +/// the browser client executable (default behavior) or from a separate +/// executable specified by the cef_settings_t.browser_subprocess_path value. If +/// called for the browser process (identified by no "type" command-line value) +/// it will return immediately with a value of -1. If called for a recognized +/// secondary process it will block until the process should exit and then +/// return the process exit code. The |application| parameter may be NULL. The +/// |windows_sandbox_info| parameter is only used on Windows and may be NULL +/// (see cef_sandbox_win.h for details). /// CEF_EXPORT int cef_execute_process(const cef_main_args_t* args, cef_app_t* application, void* windows_sandbox_info); /// -// This function should be called on the main application thread to initialize -// the CEF browser process. The |application| parameter may be NULL. A return -// value of true (1) indicates that it succeeded and false (0) indicates that it -// failed. The |windows_sandbox_info| parameter is only used on Windows and may -// be NULL (see cef_sandbox_win.h for details). +/// This function should be called on the main application thread to initialize +/// the CEF browser process. The |application| parameter may be NULL. A return +/// value of true (1) indicates that it succeeded and false (0) indicates that +/// it failed. The |windows_sandbox_info| parameter is only used on Windows and +/// may be NULL (see cef_sandbox_win.h for details). /// CEF_EXPORT int cef_initialize(const cef_main_args_t* args, const struct _cef_settings_t* settings, @@ -142,55 +144,55 @@ CEF_EXPORT int cef_initialize(const cef_main_args_t* args, void* windows_sandbox_info); /// -// This function should be called on the main application thread to shut down -// the CEF browser process before the application exits. +/// This function should be called on the main application thread to shut down +/// the CEF browser process before the application exits. /// CEF_EXPORT void cef_shutdown(void); /// -// Perform a single iteration of CEF message loop processing. This function is -// provided for cases where the CEF message loop must be integrated into an -// existing application message loop. Use of this function is not recommended -// for most users; use either the cef_run_message_loop() function or -// CefSettings.multi_threaded_message_loop if possible. When using this function -// care must be taken to balance performance against excessive CPU usage. It is -// recommended to enable the CefSettings.external_message_pump option when using -// this function so that -// cef_browser_process_handler_t::on_schedule_message_pump_work() callbacks can -// facilitate the scheduling process. This function should only be called on the -// main application thread and only if cef_initialize() is called with a -// CefSettings.multi_threaded_message_loop value of false (0). This function -// will not block. +/// Perform a single iteration of CEF message loop processing. This function is +/// provided for cases where the CEF message loop must be integrated into an +/// existing application message loop. Use of this function is not recommended +/// for most users; use either the cef_run_message_loop() function or +/// cef_settings_t.multi_threaded_message_loop if possible. When using this +/// function care must be taken to balance performance against excessive CPU +/// usage. It is recommended to enable the cef_settings_t.external_message_pump +/// option when using this function so that +/// cef_browser_process_handler_t::on_schedule_message_pump_work() callbacks can +/// facilitate the scheduling process. This function should only be called on +/// the main application thread and only if cef_initialize() is called with a +/// cef_settings_t.multi_threaded_message_loop value of false (0). This function +/// will not block. /// CEF_EXPORT void cef_do_message_loop_work(void); /// -// Run the CEF message loop. Use this function instead of an application- -// provided message loop to get the best balance between performance and CPU -// usage. This function should only be called on the main application thread and -// only if cef_initialize() is called with a -// CefSettings.multi_threaded_message_loop value of false (0). This function -// will block until a quit message is received by the system. +/// Run the CEF message loop. Use this function instead of an application- +/// provided message loop to get the best balance between performance and CPU +/// usage. This function should only be called on the main application thread +/// and only if cef_initialize() is called with a +/// cef_settings_t.multi_threaded_message_loop value of false (0). This function +/// will block until a quit message is received by the system. /// CEF_EXPORT void cef_run_message_loop(void); /// -// Quit the CEF message loop that was started by calling cef_run_message_loop(). -// This function should only be called on the main application thread and only -// if cef_run_message_loop() was used. +/// Quit the CEF message loop that was started by calling +/// cef_run_message_loop(). This function should only be called on the main +/// application thread and only if cef_run_message_loop() was used. /// CEF_EXPORT void cef_quit_message_loop(void); /// -// Set to true (1) before calling Windows APIs like TrackPopupMenu that enter a -// modal message loop. Set to false (0) after exiting the modal message loop. +/// Set to true (1) before calling Windows APIs like TrackPopupMenu that enter a +/// modal message loop. Set to false (0) after exiting the modal message loop. /// CEF_EXPORT void cef_set_osmodal_loop(int osModalLoop); /// -// Call during process startup to enable High-DPI support on Windows 7 or newer. -// Older versions of Windows should be left DPI-unaware because they do not -// support DirectWrite and GDI fonts are kerned very badly. +/// Call during process startup to enable High-DPI support on Windows 7 or +/// newer. Older versions of Windows should be left DPI-unaware because they do +/// not support DirectWrite and GDI fonts are kerned very badly. /// CEF_EXPORT void cef_enable_highdpi_support(void); diff --git a/include/capi/cef_audio_handler_capi.h b/include/capi/cef_audio_handler_capi.h index 725b6beec..f6d204ce0 100644 --- a/include/capi/cef_audio_handler_capi.h +++ b/include/capi/cef_audio_handler_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=62f58ab826b8a3d436655bf0855848632f2a73b5$ +// $hash=4e243df31e29bc6e473d56e371ed6328d948959c$ // #ifndef CEF_INCLUDE_CAPI_CEF_AUDIO_HANDLER_CAPI_H_ @@ -48,30 +48,30 @@ extern "C" { #endif /// -// Implement this structure to handle audio events. +/// Implement this structure to handle audio events. /// typedef struct _cef_audio_handler_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called on the UI thread to allow configuration of audio stream parameters. - // Return true (1) to proceed with audio stream capture, or false (0) to - // cancel it. All members of |params| can optionally be configured here, but - // they are also pre-filled with some sensible defaults. + /// Called on the UI thread to allow configuration of audio stream parameters. + /// Return true (1) to proceed with audio stream capture, or false (0) to + /// cancel it. All members of |params| can optionally be configured here, but + /// they are also pre-filled with some sensible defaults. /// int(CEF_CALLBACK* get_audio_parameters)(struct _cef_audio_handler_t* self, struct _cef_browser_t* browser, cef_audio_parameters_t* params); /// - // Called on a browser audio capture thread when the browser starts streaming - // audio. OnAudioStreamStopped will always be called after - // OnAudioStreamStarted; both functions may be called multiple times for the - // same browser. |params| contains the audio parameters like sample rate and - // channel layout. |channels| is the number of channels. + /// Called on a browser audio capture thread when the browser starts streaming + /// audio. OnAudioStreamStopped will always be called after + /// OnAudioStreamStarted; both functions may be called multiple times for the + /// same browser. |params| contains the audio parameters like sample rate and + /// channel layout. |channels| is the number of channels. /// void(CEF_CALLBACK* on_audio_stream_started)( struct _cef_audio_handler_t* self, @@ -80,14 +80,14 @@ typedef struct _cef_audio_handler_t { int channels); /// - // Called on the audio stream thread when a PCM packet is received for the - // stream. |data| is an array representing the raw PCM data as a floating - // point type, i.e. 4-byte value(s). |frames| is the number of frames in the - // PCM packet. |pts| is the presentation timestamp (in milliseconds since the - // Unix Epoch) and represents the time at which the decompressed packet should - // be presented to the user. Based on |frames| and the |channel_layout| value - // passed to OnAudioStreamStarted you can calculate the size of the |data| - // array in bytes. + /// Called on the audio stream thread when a PCM packet is received for the + /// stream. |data| is an array representing the raw PCM data as a floating + /// point type, i.e. 4-byte value(s). |frames| is the number of frames in the + /// PCM packet. |pts| is the presentation timestamp (in milliseconds since the + /// Unix Epoch) and represents the time at which the decompressed packet + /// should be presented to the user. Based on |frames| and the + /// |channel_layout| value passed to OnAudioStreamStarted you can calculate + /// the size of the |data| array in bytes. /// void(CEF_CALLBACK* on_audio_stream_packet)(struct _cef_audio_handler_t* self, struct _cef_browser_t* browser, @@ -96,18 +96,18 @@ typedef struct _cef_audio_handler_t { int64 pts); /// - // Called on the UI thread when the stream has stopped. OnAudioSteamStopped - // will always be called after OnAudioStreamStarted; both functions may be - // called multiple times for the same stream. + /// Called on the UI thread when the stream has stopped. OnAudioSteamStopped + /// will always be called after OnAudioStreamStarted; both functions may be + /// called multiple times for the same stream. /// void(CEF_CALLBACK* on_audio_stream_stopped)(struct _cef_audio_handler_t* self, struct _cef_browser_t* browser); /// - // Called on the UI or audio stream thread when an error occurred. During the - // stream creation phase this callback will be called on the UI thread while - // in the capturing phase it will be called on the audio stream thread. The - // stream will be stopped immediately. + /// Called on the UI or audio stream thread when an error occurred. During the + /// stream creation phase this callback will be called on the UI thread while + /// in the capturing phase it will be called on the audio stream thread. The + /// stream will be stopped immediately. /// void(CEF_CALLBACK* on_audio_stream_error)(struct _cef_audio_handler_t* self, struct _cef_browser_t* browser, diff --git a/include/capi/cef_auth_callback_capi.h b/include/capi/cef_auth_callback_capi.h index 604241651..76f21490f 100644 --- a/include/capi/cef_auth_callback_capi.h +++ b/include/capi/cef_auth_callback_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=01a33de48ac9780f78d606d8aee2429ddb0c81a2$ +// $hash=c0704c0a87e8b57b20887be75700a30e887fee4f$ // #ifndef CEF_INCLUDE_CAPI_CEF_AUTH_CALLBACK_CAPI_H_ @@ -47,24 +47,24 @@ extern "C" { #endif /// -// Callback structure used for asynchronous continuation of authentication -// requests. +/// Callback structure used for asynchronous continuation of authentication +/// requests. /// typedef struct _cef_auth_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Continue the authentication request. + /// Continue the authentication request. /// void(CEF_CALLBACK* cont)(struct _cef_auth_callback_t* self, const cef_string_t* username, const cef_string_t* password); /// - // Cancel the authentication request. + /// Cancel the authentication request. /// void(CEF_CALLBACK* cancel)(struct _cef_auth_callback_t* self); } cef_auth_callback_t; diff --git a/include/capi/cef_browser_capi.h b/include/capi/cef_browser_capi.h index 3a5426d5a..509f5104c 100644 --- a/include/capi/cef_browser_capi.h +++ b/include/capi/cef_browser_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=236962db4a3a66eb58546a1eab45dffb2db5178d$ +// $hash=82133f72b4df1d04fb9d980a0e9b6a1905944abb$ // #ifndef CEF_INCLUDE_CAPI_CEF_BROWSER_CAPI_H_ @@ -57,157 +57,157 @@ struct _cef_browser_host_t; struct _cef_client_t; /// -// Structure used to represent a browser. When used in the browser process the -// functions of this structure may be called on any thread unless otherwise -// indicated in the comments. When used in the render process the functions of -// this structure may only be called on the main thread. +/// Structure used to represent a browser. When used in the browser process the +/// functions of this structure may be called on any thread unless otherwise +/// indicated in the comments. When used in the render process the functions of +/// this structure may only be called on the main thread. /// typedef struct _cef_browser_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // True if this object is currently valid. This will return false (0) after - // cef_life_span_handler_t::OnBeforeClose is called. + /// True if this object is currently valid. This will return false (0) after + /// cef_life_span_handler_t::OnBeforeClose is called. /// int(CEF_CALLBACK* is_valid)(struct _cef_browser_t* self); /// - // Returns the browser host object. This function can only be called in the - // browser process. + /// Returns the browser host object. This function can only be called in the + /// browser process. /// struct _cef_browser_host_t*(CEF_CALLBACK* get_host)( struct _cef_browser_t* self); /// - // Returns true (1) if the browser can navigate backwards. + /// Returns true (1) if the browser can navigate backwards. /// int(CEF_CALLBACK* can_go_back)(struct _cef_browser_t* self); /// - // Navigate backwards. + /// Navigate backwards. /// void(CEF_CALLBACK* go_back)(struct _cef_browser_t* self); /// - // Returns true (1) if the browser can navigate forwards. + /// Returns true (1) if the browser can navigate forwards. /// int(CEF_CALLBACK* can_go_forward)(struct _cef_browser_t* self); /// - // Navigate forwards. + /// Navigate forwards. /// void(CEF_CALLBACK* go_forward)(struct _cef_browser_t* self); /// - // Returns true (1) if the browser is currently loading. + /// Returns true (1) if the browser is currently loading. /// int(CEF_CALLBACK* is_loading)(struct _cef_browser_t* self); /// - // Reload the current page. + /// Reload the current page. /// void(CEF_CALLBACK* reload)(struct _cef_browser_t* self); /// - // Reload the current page ignoring any cached data. + /// Reload the current page ignoring any cached data. /// void(CEF_CALLBACK* reload_ignore_cache)(struct _cef_browser_t* self); /// - // Stop loading the page. + /// Stop loading the page. /// void(CEF_CALLBACK* stop_load)(struct _cef_browser_t* self); /// - // Returns the globally unique identifier for this browser. This value is also - // used as the tabId for extension APIs. + /// Returns the globally unique identifier for this browser. This value is + /// also used as the tabId for extension APIs. /// int(CEF_CALLBACK* get_identifier)(struct _cef_browser_t* self); /// - // Returns true (1) if this object is pointing to the same handle as |that| - // object. + /// Returns true (1) if this object is pointing to the same handle as |that| + /// object. /// int(CEF_CALLBACK* is_same)(struct _cef_browser_t* self, struct _cef_browser_t* that); /// - // Returns true (1) if the browser is a popup. + /// Returns true (1) if the browser is a popup. /// int(CEF_CALLBACK* is_popup)(struct _cef_browser_t* self); /// - // Returns true (1) if a document has been loaded in the browser. + /// Returns true (1) if a document has been loaded in the browser. /// int(CEF_CALLBACK* has_document)(struct _cef_browser_t* self); /// - // Returns the main (top-level) frame for the browser. In the browser process - // this will return a valid object until after - // cef_life_span_handler_t::OnBeforeClose is called. In the renderer process - // this will return NULL if the main frame is hosted in a different renderer - // process (e.g. for cross-origin sub-frames). The main frame object will - // change during cross-origin navigation or re-navigation after renderer - // process termination (due to crashes, etc). + /// Returns the main (top-level) frame for the browser. In the browser process + /// this will return a valid object until after + /// cef_life_span_handler_t::OnBeforeClose is called. In the renderer process + /// this will return NULL if the main frame is hosted in a different renderer + /// process (e.g. for cross-origin sub-frames). The main frame object will + /// change during cross-origin navigation or re-navigation after renderer + /// process termination (due to crashes, etc). /// struct _cef_frame_t*(CEF_CALLBACK* get_main_frame)( struct _cef_browser_t* self); /// - // Returns the focused frame for the browser. + /// Returns the focused frame for the browser. /// struct _cef_frame_t*(CEF_CALLBACK* get_focused_frame)( struct _cef_browser_t* self); /// - // Returns the frame with the specified identifier, or NULL if not found. + /// Returns the frame with the specified identifier, or NULL if not found. /// struct _cef_frame_t*(CEF_CALLBACK* get_frame_byident)( struct _cef_browser_t* self, int64 identifier); /// - // Returns the frame with the specified name, or NULL if not found. + /// Returns the frame with the specified name, or NULL if not found. /// struct _cef_frame_t*(CEF_CALLBACK* get_frame)(struct _cef_browser_t* self, const cef_string_t* name); /// - // Returns the number of frames that currently exist. + /// Returns the number of frames that currently exist. /// size_t(CEF_CALLBACK* get_frame_count)(struct _cef_browser_t* self); /// - // Returns the identifiers of all existing frames. + /// Returns the identifiers of all existing frames. /// void(CEF_CALLBACK* get_frame_identifiers)(struct _cef_browser_t* self, size_t* identifiersCount, int64* identifiers); /// - // Returns the names of all existing frames. + /// Returns the names of all existing frames. /// void(CEF_CALLBACK* get_frame_names)(struct _cef_browser_t* self, cef_string_list_t names); } cef_browser_t; /// -// Callback structure for cef_browser_host_t::RunFileDialog. The functions of -// this structure will be called on the browser process UI thread. +/// Callback structure for cef_browser_host_t::RunFileDialog. The functions of +/// this structure will be called on the browser process UI thread. /// typedef struct _cef_run_file_dialog_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called asynchronously after the file dialog is dismissed. |file_paths| will - // be a single value or a list of values depending on the dialog mode. If the - // selection was cancelled |file_paths| will be NULL. + /// Called asynchronously after the file dialog is dismissed. |file_paths| + /// will be a single value or a list of values depending on the dialog mode. + /// If the selection was cancelled |file_paths| will be NULL. /// void(CEF_CALLBACK* on_file_dialog_dismissed)( struct _cef_run_file_dialog_callback_t* self, @@ -215,21 +215,21 @@ typedef struct _cef_run_file_dialog_callback_t { } cef_run_file_dialog_callback_t; /// -// Callback structure for cef_browser_host_t::GetNavigationEntries. The -// functions of this structure will be called on the browser process UI thread. +/// Callback structure for cef_browser_host_t::GetNavigationEntries. The +/// functions of this structure will be called on the browser process UI thread. /// typedef struct _cef_navigation_entry_visitor_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Method that will be executed. Do not keep a reference to |entry| outside of - // this callback. Return true (1) to continue visiting entries or false (0) to - // stop. |current| is true (1) if this entry is the currently loaded - // navigation entry. |index| is the 0-based index of this entry and |total| is - // the total number of entries. + /// Method that will be executed. Do not keep a reference to |entry| outside + /// of this callback. Return true (1) to continue visiting entries or false + /// (0) to stop. |current| is true (1) if this entry is the currently loaded + /// navigation entry. |index| is the 0-based index of this entry and |total| + /// is the total number of entries. /// int(CEF_CALLBACK* visit)(struct _cef_navigation_entry_visitor_t* self, struct _cef_navigation_entry_t* entry, @@ -239,19 +239,19 @@ typedef struct _cef_navigation_entry_visitor_t { } cef_navigation_entry_visitor_t; /// -// Callback structure for cef_browser_host_t::PrintToPDF. The functions of this -// structure will be called on the browser process UI thread. +/// Callback structure for cef_browser_host_t::PrintToPDF. The functions of this +/// structure will be called on the browser process UI thread. /// typedef struct _cef_pdf_print_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Method that will be executed when the PDF printing has completed. |path| is - // the output path. |ok| will be true (1) if the printing completed - // successfully or false (0) otherwise. + /// Method that will be executed when the PDF printing has completed. |path| + /// is the output path. |ok| will be true (1) if the printing completed + /// successfully or false (0) otherwise. /// void(CEF_CALLBACK* on_pdf_print_finished)( struct _cef_pdf_print_callback_t* self, @@ -260,20 +260,20 @@ typedef struct _cef_pdf_print_callback_t { } cef_pdf_print_callback_t; /// -// Callback structure for cef_browser_host_t::DownloadImage. The functions of -// this structure will be called on the browser process UI thread. +/// Callback structure for cef_browser_host_t::DownloadImage. The functions of +/// this structure will be called on the browser process UI thread. /// typedef struct _cef_download_image_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Method that will be executed when the image download has completed. - // |image_url| is the URL that was downloaded and |http_status_code| is the - // resulting HTTP status code. |image| is the resulting image, possibly at - // multiple scale factors, or NULL if the download failed. + /// Method that will be executed when the image download has completed. + /// |image_url| is the URL that was downloaded and |http_status_code| is the + /// resulting HTTP status code. |image| is the resulting image, possibly at + /// multiple scale factors, or NULL if the download failed. /// void(CEF_CALLBACK* on_download_image_finished)( struct _cef_download_image_callback_t* self, @@ -283,115 +283,116 @@ typedef struct _cef_download_image_callback_t { } cef_download_image_callback_t; /// -// Structure used to represent the browser process aspects of a browser. The -// functions of this structure can only be called in the browser process. They -// may be called on any thread in that process unless otherwise indicated in the -// comments. +/// Structure used to represent the browser process aspects of a browser. The +/// functions of this structure can only be called in the browser process. They +/// may be called on any thread in that process unless otherwise indicated in +/// the comments. /// typedef struct _cef_browser_host_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Returns the hosted browser object. + /// Returns the hosted browser object. /// struct _cef_browser_t*(CEF_CALLBACK* get_browser)( struct _cef_browser_host_t* self); /// - // Request that the browser close. The JavaScript 'onbeforeunload' event will - // be fired. If |force_close| is false (0) the event handler, if any, will be - // allowed to prompt the user and the user can optionally cancel the close. If - // |force_close| is true (1) the prompt will not be displayed and the close - // will proceed. Results in a call to cef_life_span_handler_t::do_close() if - // the event handler allows the close or if |force_close| is true (1). See - // cef_life_span_handler_t::do_close() documentation for additional usage - // information. + /// Request that the browser close. The JavaScript 'onbeforeunload' event will + /// be fired. If |force_close| is false (0) the event handler, if any, will be + /// allowed to prompt the user and the user can optionally cancel the close. + /// If |force_close| is true (1) the prompt will not be displayed and the + /// close will proceed. Results in a call to + /// cef_life_span_handler_t::do_close() if the event handler allows the close + /// or if |force_close| is true (1). See cef_life_span_handler_t::do_close() + /// documentation for additional usage information. /// void(CEF_CALLBACK* close_browser)(struct _cef_browser_host_t* self, int force_close); /// - // Helper for closing a browser. Call this function from the top-level window - // close handler (if any). Internally this calls CloseBrowser(false (0)) if - // the close has not yet been initiated. This function returns false (0) while - // the close is pending and true (1) after the close has completed. See - // close_browser() and cef_life_span_handler_t::do_close() documentation for - // additional usage information. This function must be called on the browser - // process UI thread. + /// Helper for closing a browser. Call this function from the top-level window + /// close handler (if any). Internally this calls CloseBrowser(false (0)) if + /// the close has not yet been initiated. This function returns false (0) + /// while the close is pending and true (1) after the close has completed. See + /// close_browser() and cef_life_span_handler_t::do_close() documentation for + /// additional usage information. This function must be called on the browser + /// process UI thread. /// int(CEF_CALLBACK* try_close_browser)(struct _cef_browser_host_t* self); /// - // Set whether the browser is focused. + /// Set whether the browser is focused. /// void(CEF_CALLBACK* set_focus)(struct _cef_browser_host_t* self, int focus); /// - // Retrieve the window handle (if any) for this browser. If this browser is - // wrapped in a cef_browser_view_t this function should be called on the - // browser process UI thread and it will return the handle for the top-level - // native window. + /// Retrieve the window handle (if any) for this browser. If this browser is + /// wrapped in a cef_browser_view_t this function should be called on the + /// browser process UI thread and it will return the handle for the top-level + /// native window. /// cef_window_handle_t(CEF_CALLBACK* get_window_handle)( struct _cef_browser_host_t* self); /// - // Retrieve the window handle (if any) of the browser that opened this - // browser. Will return NULL for non-popup browsers or if this browser is - // wrapped in a cef_browser_view_t. This function can be used in combination - // with custom handling of modal windows. + /// Retrieve the window handle (if any) of the browser that opened this + /// browser. Will return NULL for non-popup browsers or if this browser is + /// wrapped in a cef_browser_view_t. This function can be used in combination + /// with custom handling of modal windows. /// cef_window_handle_t(CEF_CALLBACK* get_opener_window_handle)( struct _cef_browser_host_t* self); /// - // Returns true (1) if this browser is wrapped in a cef_browser_view_t. + /// Returns true (1) if this browser is wrapped in a cef_browser_view_t. /// int(CEF_CALLBACK* has_view)(struct _cef_browser_host_t* self); /// - // Returns the client for this browser. + /// Returns the client for this browser. /// struct _cef_client_t*(CEF_CALLBACK* get_client)( struct _cef_browser_host_t* self); /// - // Returns the request context for this browser. + /// Returns the request context for this browser. /// struct _cef_request_context_t*(CEF_CALLBACK* get_request_context)( struct _cef_browser_host_t* self); /// - // Get the current zoom level. The default zoom level is 0.0. This function - // can only be called on the UI thread. + /// Get the current zoom level. The default zoom level is 0.0. This function + /// can only be called on the UI thread. /// double(CEF_CALLBACK* get_zoom_level)(struct _cef_browser_host_t* self); /// - // Change the zoom level to the specified value. Specify 0.0 to reset the zoom - // level. If called on the UI thread the change will be applied immediately. - // Otherwise, the change will be applied asynchronously on the UI thread. + /// Change the zoom level to the specified value. Specify 0.0 to reset the + /// zoom level. If called on the UI thread the change will be applied + /// immediately. Otherwise, the change will be applied asynchronously on the + /// UI thread. /// void(CEF_CALLBACK* set_zoom_level)(struct _cef_browser_host_t* self, double zoomLevel); /// - // Call to run a file chooser dialog. Only a single file chooser dialog may be - // pending at any given time. |mode| represents the type of dialog to display. - // |title| to the title to be used for the dialog and may be NULL to show the - // default title ("Open" or "Save" depending on the mode). |default_file_path| - // is the path with optional directory and/or file name component that will be - // initially selected in the dialog. |accept_filters| are used to restrict the - // selectable file types and may any combination of (a) valid lower-cased MIME - // types (e.g. "text/*" or "image/*"), (b) individual file extensions (e.g. - // ".txt" or ".png"), or (c) combined description and file extension delimited - // using "|" and ";" (e.g. "Image Types|.png;.gif;.jpg"). |callback| will be - // executed after the dialog is dismissed or immediately if another dialog is - // already pending. The dialog will be initiated asynchronously on the UI - // thread. + /// Call to run a file chooser dialog. Only a single file chooser dialog may + /// be pending at any given time. |mode| represents the type of dialog to + /// display. |title| to the title to be used for the dialog and may be NULL to + /// show the default title ("Open" or "Save" depending on the mode). + /// |default_file_path| is the path with optional directory and/or file name + /// component that will be initially selected in the dialog. |accept_filters| + /// are used to restrict the selectable file types and may any combination of + /// (a) valid lower-cased MIME types (e.g. "text/*" or "image/*"), (b) + /// individual file extensions (e.g. ".txt" or ".png"), or (c) combined + /// description and file extension delimited using "|" and ";" (e.g. "Image + /// Types|.png;.gif;.jpg"). |callback| will be executed after the dialog is + /// dismissed or immediately if another dialog is already pending. The dialog + /// will be initiated asynchronously on the UI thread. /// void(CEF_CALLBACK* run_file_dialog)( struct _cef_browser_host_t* self, @@ -402,22 +403,22 @@ typedef struct _cef_browser_host_t { struct _cef_run_file_dialog_callback_t* callback); /// - // Download the file at |url| using cef_download_handler_t. + /// Download the file at |url| using cef_download_handler_t. /// void(CEF_CALLBACK* start_download)(struct _cef_browser_host_t* self, const cef_string_t* url); /// - // Download |image_url| and execute |callback| on completion with the images - // received from the renderer. If |is_favicon| is true (1) then cookies are - // not sent and not accepted during download. Images with density independent - // pixel (DIP) sizes larger than |max_image_size| are filtered out from the - // image results. Versions of the image at different scale factors may be - // downloaded up to the maximum scale factor supported by the system. If there - // are no image results <= |max_image_size| then the smallest image is resized - // to |max_image_size| and is the only result. A |max_image_size| of 0 means - // unlimited. If |bypass_cache| is true (1) then |image_url| is requested from - // the server even if it is present in the browser cache. + /// Download |image_url| and execute |callback| on completion with the images + /// received from the renderer. If |is_favicon| is true (1) then cookies are + /// not sent and not accepted during download. Images with density independent + /// pixel (DIP) sizes larger than |max_image_size| are filtered out from the + /// image results. Versions of the image at different scale factors may be + /// downloaded up to the maximum scale factor supported by the system. If + /// there are no image results <= |max_image_size| then the smallest image is + /// resized to |max_image_size| and is the only result. A |max_image_size| of + /// 0 means unlimited. If |bypass_cache| is true (1) then |image_url| is + /// requested from the server even if it is present in the browser cache. /// void(CEF_CALLBACK* download_image)( struct _cef_browser_host_t* self, @@ -428,15 +429,15 @@ typedef struct _cef_browser_host_t { struct _cef_download_image_callback_t* callback); /// - // Print the current browser contents. + /// Print the current browser contents. /// void(CEF_CALLBACK* print)(struct _cef_browser_host_t* self); /// - // Print the current browser contents to the PDF file specified by |path| and - // execute |callback| on completion. The caller is responsible for deleting - // |path| when done. For PDF printing to work on Linux you must implement the - // cef_print_handler_t::GetPdfPaperSize function. + /// Print the current browser contents to the PDF file specified by |path| and + /// execute |callback| on completion. The caller is responsible for deleting + /// |path| when done. For PDF printing to work on Linux you must implement the + /// cef_print_handler_t::GetPdfPaperSize function. /// void(CEF_CALLBACK* print_to_pdf)( struct _cef_browser_host_t* self, @@ -445,13 +446,13 @@ typedef struct _cef_browser_host_t { struct _cef_pdf_print_callback_t* callback); /// - // Search for |searchText|. |forward| indicates whether to search forward or - // backward within the page. |matchCase| indicates whether the search should - // be case-sensitive. |findNext| indicates whether this is the first request - // or a follow-up. The search will be restarted if |searchText| or |matchCase| - // change. The search will be stopped if |searchText| is NULL. The - // cef_find_handler_t instance, if any, returned via - // cef_client_t::GetFindHandler will be called to report find results. + /// Search for |searchText|. |forward| indicates whether to search forward or + /// backward within the page. |matchCase| indicates whether the search should + /// be case-sensitive. |findNext| indicates whether this is the first request + /// or a follow-up. The search will be restarted if |searchText| or + /// |matchCase| change. The search will be stopped if |searchText| is NULL. + /// The cef_find_handler_t instance, if any, returned via + /// cef_client_t::GetFindHandler will be called to report find results. /// void(CEF_CALLBACK* find)(struct _cef_browser_host_t* self, const cef_string_t* searchText, @@ -460,19 +461,19 @@ typedef struct _cef_browser_host_t { int findNext); /// - // Cancel all searches that are currently going on. + /// Cancel all searches that are currently going on. /// void(CEF_CALLBACK* stop_finding)(struct _cef_browser_host_t* self, int clearSelection); /// - // Open developer tools (DevTools) in its own browser. The DevTools browser - // will remain associated with this browser. If the DevTools browser is - // already open then it will be focused, in which case the |windowInfo|, - // |client| and |settings| parameters will be ignored. If |inspect_element_at| - // is non-NULL then the element at the specified (x,y) location will be - // inspected. The |windowInfo| parameter will be ignored if this browser is - // wrapped in a cef_browser_view_t. + /// Open developer tools (DevTools) in its own browser. The DevTools browser + /// will remain associated with this browser. If the DevTools browser is + /// already open then it will be focused, in which case the |windowInfo|, + /// |client| and |settings| parameters will be ignored. If + /// |inspect_element_at| is non-NULL then the element at the specified (x,y) + /// location will be inspected. The |windowInfo| parameter will be ignored if + /// this browser is wrapped in a cef_browser_view_t. /// void(CEF_CALLBACK* show_dev_tools)( struct _cef_browser_host_t* self, @@ -482,64 +483,65 @@ typedef struct _cef_browser_host_t { const cef_point_t* inspect_element_at); /// - // Explicitly close the associated DevTools browser, if any. + /// Explicitly close the associated DevTools browser, if any. /// void(CEF_CALLBACK* close_dev_tools)(struct _cef_browser_host_t* self); /// - // Returns true (1) if this browser currently has an associated DevTools - // browser. Must be called on the browser process UI thread. + /// Returns true (1) if this browser currently has an associated DevTools + /// browser. Must be called on the browser process UI thread. /// int(CEF_CALLBACK* has_dev_tools)(struct _cef_browser_host_t* self); /// - // Send a function call message over the DevTools protocol. |message| must be - // a UTF8-encoded JSON dictionary that contains "id" (int), "function" - // (string) and "params" (dictionary, optional) values. See the DevTools - // protocol documentation at https://chromedevtools.github.io/devtools- - // protocol/ for details of supported functions and the expected "params" - // dictionary contents. |message| will be copied if necessary. This function - // will return true (1) if called on the UI thread and the message was - // successfully submitted for validation, otherwise false (0). Validation will - // be applied asynchronously and any messages that fail due to formatting - // errors or missing parameters may be discarded without notification. Prefer - // ExecuteDevToolsMethod if a more structured approach to message formatting - // is desired. - // - // Every valid function call will result in an asynchronous function result or - // error message that references the sent message "id". Event messages are - // received while notifications are enabled (for example, between function - // calls for "Page.enable" and "Page.disable"). All received messages will be - // delivered to the observer(s) registered with AddDevToolsMessageObserver. - // See cef_dev_tools_message_observer_t::OnDevToolsMessage documentation for - // details of received message contents. - // - // Usage of the SendDevToolsMessage, ExecuteDevToolsMethod and - // AddDevToolsMessageObserver functions does not require an active DevTools - // front-end or remote-debugging session. Other active DevTools sessions will - // continue to function independently. However, any modification of global - // browser state by one session may not be reflected in the UI of other - // sessions. - // - // Communication with the DevTools front-end (when displayed) can be logged - // for development purposes by passing the `--devtools-protocol-log- - // file=` command-line flag. + /// Send a function call message over the DevTools protocol. |message| must be + /// a UTF8-encoded JSON dictionary that contains "id" (int), "function" + /// (string) and "params" (dictionary, optional) values. See the DevTools + /// protocol documentation at https://chromedevtools.github.io/devtools- + /// protocol/ for details of supported functions and the expected "params" + /// dictionary contents. |message| will be copied if necessary. This function + /// will return true (1) if called on the UI thread and the message was + /// successfully submitted for validation, otherwise false (0). Validation + /// will be applied asynchronously and any messages that fail due to + /// formatting errors or missing parameters may be discarded without + /// notification. Prefer ExecuteDevToolsMethod if a more structured approach + /// to message formatting is desired. + /// + /// Every valid function call will result in an asynchronous function result + /// or error message that references the sent message "id". Event messages are + /// received while notifications are enabled (for example, between function + /// calls for "Page.enable" and "Page.disable"). All received messages will be + /// delivered to the observer(s) registered with AddDevToolsMessageObserver. + /// See cef_dev_tools_message_observer_t::OnDevToolsMessage documentation for + /// details of received message contents. + /// + /// Usage of the SendDevToolsMessage, ExecuteDevToolsMethod and + /// AddDevToolsMessageObserver functions does not require an active DevTools + /// front-end or remote-debugging session. Other active DevTools sessions will + /// continue to function independently. However, any modification of global + /// browser state by one session may not be reflected in the UI of other + /// sessions. + /// + /// Communication with the DevTools front-end (when displayed) can be logged + /// for development purposes by passing the `--devtools-protocol-log- + /// file=` command-line flag. /// int(CEF_CALLBACK* send_dev_tools_message)(struct _cef_browser_host_t* self, const void* message, size_t message_size); /// - // Execute a function call over the DevTools protocol. This is a more - // structured version of SendDevToolsMessage. |message_id| is an incremental - // number that uniquely identifies the message (pass 0 to have the next number - // assigned automatically based on previous values). |function| is the - // function name. |params| are the function parameters, which may be NULL. See - // the DevTools protocol documentation (linked above) for details of supported - // functions and the expected |params| dictionary contents. This function will - // return the assigned message ID if called on the UI thread and the message - // was successfully submitted for validation, otherwise 0. See the - // SendDevToolsMessage documentation for additional usage information. + /// Execute a function call over the DevTools protocol. This is a more + /// structured version of SendDevToolsMessage. |message_id| is an incremental + /// number that uniquely identifies the message (pass 0 to have the next + /// number assigned automatically based on previous values). |function| is the + /// function name. |params| are the function parameters, which may be NULL. + /// See the DevTools protocol documentation (linked above) for details of + /// supported functions and the expected |params| dictionary contents. This + /// function will return the assigned message ID if called on the UI thread + /// and the message was successfully submitted for validation, otherwise 0. + /// See the SendDevToolsMessage documentation for additional usage + /// information. /// int(CEF_CALLBACK* execute_dev_tools_method)( struct _cef_browser_host_t* self, @@ -548,20 +550,20 @@ typedef struct _cef_browser_host_t { struct _cef_dictionary_value_t* params); /// - // Add an observer for DevTools protocol messages (function results and - // events). The observer will remain registered until the returned - // Registration object is destroyed. See the SendDevToolsMessage documentation - // for additional usage information. + /// Add an observer for DevTools protocol messages (function results and + /// events). The observer will remain registered until the returned + /// Registration object is destroyed. See the SendDevToolsMessage + /// documentation for additional usage information. /// struct _cef_registration_t*(CEF_CALLBACK* add_dev_tools_message_observer)( struct _cef_browser_host_t* self, struct _cef_dev_tools_message_observer_t* observer); /// - // Retrieve a snapshot of current navigation entries as values sent to the - // specified visitor. If |current_only| is true (1) only the current - // navigation entry will be sent, otherwise all navigation entries will be - // sent. + /// Retrieve a snapshot of current navigation entries as values sent to the + /// specified visitor. If |current_only| is true (1) only the current + /// navigation entry will be sent, otherwise all navigation entries will be + /// sent. /// void(CEF_CALLBACK* get_navigation_entries)( struct _cef_browser_host_t* self, @@ -569,74 +571,74 @@ typedef struct _cef_browser_host_t { int current_only); /// - // If a misspelled word is currently selected in an editable node calling this - // function will replace it with the specified |word|. + /// If a misspelled word is currently selected in an editable node calling + /// this function will replace it with the specified |word|. /// void(CEF_CALLBACK* replace_misspelling)(struct _cef_browser_host_t* self, const cef_string_t* word); /// - // Add the specified |word| to the spelling dictionary. + /// Add the specified |word| to the spelling dictionary. /// void(CEF_CALLBACK* add_word_to_dictionary)(struct _cef_browser_host_t* self, const cef_string_t* word); /// - // Returns true (1) if window rendering is disabled. + /// Returns true (1) if window rendering is disabled. /// int(CEF_CALLBACK* is_window_rendering_disabled)( struct _cef_browser_host_t* self); /// - // Notify the browser that the widget has been resized. The browser will first - // call cef_render_handler_t::GetViewRect to get the new size and then call - // cef_render_handler_t::OnPaint asynchronously with the updated regions. This - // function is only used when window rendering is disabled. + /// Notify the browser that the widget has been resized. The browser will + /// first call cef_render_handler_t::GetViewRect to get the new size and then + /// call cef_render_handler_t::OnPaint asynchronously with the updated + /// regions. This function is only used when window rendering is disabled. /// void(CEF_CALLBACK* was_resized)(struct _cef_browser_host_t* self); /// - // Notify the browser that it has been hidden or shown. Layouting and - // cef_render_handler_t::OnPaint notification will stop when the browser is - // hidden. This function is only used when window rendering is disabled. + /// Notify the browser that it has been hidden or shown. Layouting and + /// cef_render_handler_t::OnPaint notification will stop when the browser is + /// hidden. This function is only used when window rendering is disabled. /// void(CEF_CALLBACK* was_hidden)(struct _cef_browser_host_t* self, int hidden); /// - // Send a notification to the browser that the screen info has changed. The - // browser will then call cef_render_handler_t::GetScreenInfo to update the - // screen information with the new values. This simulates moving the webview - // window from one display to another, or changing the properties of the - // current display. This function is only used when window rendering is - // disabled. + /// Send a notification to the browser that the screen info has changed. The + /// browser will then call cef_render_handler_t::GetScreenInfo to update the + /// screen information with the new values. This simulates moving the webview + /// window from one display to another, or changing the properties of the + /// current display. This function is only used when window rendering is + /// disabled. /// void(CEF_CALLBACK* notify_screen_info_changed)( struct _cef_browser_host_t* self); /// - // Invalidate the view. The browser will call cef_render_handler_t::OnPaint - // asynchronously. This function is only used when window rendering is - // disabled. + /// Invalidate the view. The browser will call cef_render_handler_t::OnPaint + /// asynchronously. This function is only used when window rendering is + /// disabled. /// void(CEF_CALLBACK* invalidate)(struct _cef_browser_host_t* self, cef_paint_element_type_t type); /// - // Issue a BeginFrame request to Chromium. Only valid when - // cef_window_tInfo::external_begin_frame_enabled is set to true (1). + /// Issue a BeginFrame request to Chromium. Only valid when + /// cef_window_tInfo::external_begin_frame_enabled is set to true (1). /// void(CEF_CALLBACK* send_external_begin_frame)( struct _cef_browser_host_t* self); /// - // Send a key event to the browser. + /// Send a key event to the browser. /// void(CEF_CALLBACK* send_key_event)(struct _cef_browser_host_t* self, const cef_key_event_t* event); /// - // Send a mouse click event to the browser. The |x| and |y| coordinates are - // relative to the upper-left corner of the view. + /// Send a mouse click event to the browser. The |x| and |y| coordinates are + /// relative to the upper-left corner of the view. /// void(CEF_CALLBACK* send_mouse_click_event)(struct _cef_browser_host_t* self, const cef_mouse_event_t* event, @@ -645,19 +647,20 @@ typedef struct _cef_browser_host_t { int clickCount); /// - // Send a mouse move event to the browser. The |x| and |y| coordinates are - // relative to the upper-left corner of the view. + /// Send a mouse move event to the browser. The |x| and |y| coordinates are + /// relative to the upper-left corner of the view. /// void(CEF_CALLBACK* send_mouse_move_event)(struct _cef_browser_host_t* self, const cef_mouse_event_t* event, int mouseLeave); /// - // Send a mouse wheel event to the browser. The |x| and |y| coordinates are - // relative to the upper-left corner of the view. The |deltaX| and |deltaY| - // values represent the movement delta in the X and Y directions respectively. - // In order to scroll inside select popups with window rendering disabled - // cef_render_handler_t::GetScreenPoint should be implemented properly. + /// Send a mouse wheel event to the browser. The |x| and |y| coordinates are + /// relative to the upper-left corner of the view. The |deltaX| and |deltaY| + /// values represent the movement delta in the X and Y directions + /// respectively. In order to scroll inside select popups with window + /// rendering disabled cef_render_handler_t::GetScreenPoint should be + /// implemented properly. /// void(CEF_CALLBACK* send_mouse_wheel_event)(struct _cef_browser_host_t* self, const cef_mouse_event_t* event, @@ -665,66 +668,69 @@ typedef struct _cef_browser_host_t { int deltaY); /// - // Send a touch event to the browser for a windowless browser. + /// Send a touch event to the browser for a windowless browser. /// void(CEF_CALLBACK* send_touch_event)(struct _cef_browser_host_t* self, const cef_touch_event_t* event); /// - // Send a capture lost event to the browser. + /// Send a capture lost event to the browser. /// void(CEF_CALLBACK* send_capture_lost_event)(struct _cef_browser_host_t* self); /// - // Notify the browser that the window hosting it is about to be moved or - // resized. This function is only used on Windows and Linux. + /// Notify the browser that the window hosting it is about to be moved or + /// resized. This function is only used on Windows and Linux. /// void(CEF_CALLBACK* notify_move_or_resize_started)( struct _cef_browser_host_t* self); /// - // Returns the maximum rate in frames per second (fps) that - // cef_render_handler_t:: OnPaint will be called for a windowless browser. The - // actual fps may be lower if the browser cannot generate frames at the - // requested rate. The minimum value is 1 and the maximum value is 60 (default - // 30). This function can only be called on the UI thread. + /// Returns the maximum rate in frames per second (fps) that + /// cef_render_handler_t:: OnPaint will be called for a windowless browser. + /// The actual fps may be lower if the browser cannot generate frames at the + /// requested rate. The minimum value is 1 and the maximum value is 60 + /// (default 30). This function can only be called on the UI thread. /// int(CEF_CALLBACK* get_windowless_frame_rate)( struct _cef_browser_host_t* self); /// - // Set the maximum rate in frames per second (fps) that cef_render_handler_t:: - // OnPaint will be called for a windowless browser. The actual fps may be - // lower if the browser cannot generate frames at the requested rate. The - // minimum value is 1 and the maximum value is 60 (default 30). Can also be - // set at browser creation via cef_browser_tSettings.windowless_frame_rate. + /// Set the maximum rate in frames per second (fps) that + /// cef_render_handler_t:: OnPaint will be called for a windowless browser. + /// The actual fps may be lower if the browser cannot generate frames at the + /// requested rate. The minimum value is 1 and the maximum value is 60 + /// (default 30). Can also be set at browser creation via + /// cef_browser_tSettings.windowless_frame_rate. /// void(CEF_CALLBACK* set_windowless_frame_rate)( struct _cef_browser_host_t* self, int frame_rate); /// - // Begins a new composition or updates the existing composition. Blink has a - // special node (a composition node) that allows the input function to change - // text without affecting other DOM nodes. |text| is the optional text that - // will be inserted into the composition node. |underlines| is an optional set - // of ranges that will be underlined in the resulting text. - // |replacement_range| is an optional range of the existing text that will be - // replaced. |selection_range| is an optional range of the resulting text that - // will be selected after insertion or replacement. The |replacement_range| - // value is only used on OS X. - // - // This function may be called multiple times as the composition changes. When - // the client is done making changes the composition should either be canceled - // or completed. To cancel the composition call ImeCancelComposition. To - // complete the composition call either ImeCommitText or - // ImeFinishComposingText. Completion is usually signaled when: - // A. The client receives a WM_IME_COMPOSITION message with a GCS_RESULTSTR - // flag (on Windows), or; - // B. The client receives a "commit" signal of GtkIMContext (on Linux), or; - // C. insertText of NSTextInput is called (on Mac). - // - // This function is only used when window rendering is disabled. + /// Begins a new composition or updates the existing composition. Blink has a + /// special node (a composition node) that allows the input function to change + /// text without affecting other DOM nodes. |text| is the optional text that + /// will be inserted into the composition node. |underlines| is an optional + /// set of ranges that will be underlined in the resulting text. + /// |replacement_range| is an optional range of the existing text that will be + /// replaced. |selection_range| is an optional range of the resulting text + /// that will be selected after insertion or replacement. The + /// |replacement_range| value is only used on OS X. + /// + /// This function may be called multiple times as the composition changes. + /// When the client is done making changes the composition should either be + /// canceled or completed. To cancel the composition call + /// ImeCancelComposition. To complete the composition call either + /// ImeCommitText or ImeFinishComposingText. Completion is usually signaled + /// when: + /// + /// 1. The client receives a WM_IME_COMPOSITION message with a GCS_RESULTSTR + /// flag (on Windows), or; + /// 2. The client receives a "commit" signal of GtkIMContext (on Linux), or; + /// 3. insertText of NSTextInput is called (on Mac). + /// + /// This function is only used when window rendering is disabled. /// void(CEF_CALLBACK* ime_set_composition)( struct _cef_browser_host_t* self, @@ -735,13 +741,13 @@ typedef struct _cef_browser_host_t { const cef_range_t* selection_range); /// - // Completes the existing composition by optionally inserting the specified - // |text| into the composition node. |replacement_range| is an optional range - // of the existing text that will be replaced. |relative_cursor_pos| is where - // the cursor will be positioned relative to the current cursor position. See - // comments on ImeSetComposition for usage. The |replacement_range| and - // |relative_cursor_pos| values are only used on OS X. This function is only - // used when window rendering is disabled. + /// Completes the existing composition by optionally inserting the specified + /// |text| into the composition node. |replacement_range| is an optional range + /// of the existing text that will be replaced. |relative_cursor_pos| is where + /// the cursor will be positioned relative to the current cursor position. See + /// comments on ImeSetComposition for usage. The |replacement_range| and + /// |relative_cursor_pos| values are only used on OS X. This function is only + /// used when window rendering is disabled. /// void(CEF_CALLBACK* ime_commit_text)(struct _cef_browser_host_t* self, const cef_string_t* text, @@ -749,30 +755,30 @@ typedef struct _cef_browser_host_t { int relative_cursor_pos); /// - // Completes the existing composition by applying the current composition node - // contents. If |keep_selection| is false (0) the current selection, if any, - // will be discarded. See comments on ImeSetComposition for usage. This - // function is only used when window rendering is disabled. + /// Completes the existing composition by applying the current composition + /// node contents. If |keep_selection| is false (0) the current selection, if + /// any, will be discarded. See comments on ImeSetComposition for usage. This + /// function is only used when window rendering is disabled. /// void(CEF_CALLBACK* ime_finish_composing_text)( struct _cef_browser_host_t* self, int keep_selection); /// - // Cancels the existing composition and discards the composition node contents - // without applying them. See comments on ImeSetComposition for usage. This - // function is only used when window rendering is disabled. + /// Cancels the existing composition and discards the composition node + /// contents without applying them. See comments on ImeSetComposition for + /// usage. This function is only used when window rendering is disabled. /// void(CEF_CALLBACK* ime_cancel_composition)(struct _cef_browser_host_t* self); /// - // Call this function when the user drags the mouse into the web view (before - // calling DragTargetDragOver/DragTargetLeave/DragTargetDrop). |drag_data| - // should not contain file contents as this type of data is not allowed to be - // dragged into the web view. File contents can be removed using - // cef_drag_data_t::ResetFileContents (for example, if |drag_data| comes from - // cef_render_handler_t::StartDragging). This function is only used when - // window rendering is disabled. + /// Call this function when the user drags the mouse into the web view (before + /// calling DragTargetDragOver/DragTargetLeave/DragTargetDrop). |drag_data| + /// should not contain file contents as this type of data is not allowed to be + /// dragged into the web view. File contents can be removed using + /// cef_drag_data_t::ResetFileContents (for example, if |drag_data| comes from + /// cef_render_handler_t::StartDragging). This function is only used when + /// window rendering is disabled. /// void(CEF_CALLBACK* drag_target_drag_enter)( struct _cef_browser_host_t* self, @@ -781,10 +787,10 @@ typedef struct _cef_browser_host_t { cef_drag_operations_mask_t allowed_ops); /// - // Call this function each time the mouse is moved across the web view during - // a drag operation (after calling DragTargetDragEnter and before calling - // DragTargetDragLeave/DragTargetDrop). This function is only used when window - // rendering is disabled. + /// Call this function each time the mouse is moved across the web view during + /// a drag operation (after calling DragTargetDragEnter and before calling + /// DragTargetDragLeave/DragTargetDrop). This function is only used when + /// window rendering is disabled. /// void(CEF_CALLBACK* drag_target_drag_over)( struct _cef_browser_host_t* self, @@ -792,30 +798,30 @@ typedef struct _cef_browser_host_t { cef_drag_operations_mask_t allowed_ops); /// - // Call this function when the user drags the mouse out of the web view (after - // calling DragTargetDragEnter). This function is only used when window - // rendering is disabled. + /// Call this function when the user drags the mouse out of the web view + /// (after calling DragTargetDragEnter). This function is only used when + /// window rendering is disabled. /// void(CEF_CALLBACK* drag_target_drag_leave)(struct _cef_browser_host_t* self); /// - // Call this function when the user completes the drag operation by dropping - // the object onto the web view (after calling DragTargetDragEnter). The - // object being dropped is |drag_data|, given as an argument to the previous - // DragTargetDragEnter call. This function is only used when window rendering - // is disabled. + /// Call this function when the user completes the drag operation by dropping + /// the object onto the web view (after calling DragTargetDragEnter). The + /// object being dropped is |drag_data|, given as an argument to the previous + /// DragTargetDragEnter call. This function is only used when window rendering + /// is disabled. /// void(CEF_CALLBACK* drag_target_drop)(struct _cef_browser_host_t* self, const cef_mouse_event_t* event); /// - // Call this function when the drag operation started by a - // cef_render_handler_t::StartDragging call has ended either in a drop or by - // being cancelled. |x| and |y| are mouse coordinates relative to the upper- - // left corner of the view. If the web view is both the drag source and the - // drag target then all DragTarget* functions should be called before - // DragSource* mthods. This function is only used when window rendering is - // disabled. + /// Call this function when the drag operation started by a + /// cef_render_handler_t::StartDragging call has ended either in a drop or by + /// being cancelled. |x| and |y| are mouse coordinates relative to the upper- + /// left corner of the view. If the web view is both the drag source and the + /// drag target then all DragTarget* functions should be called before + /// DragSource* mthods. This function is only used when window rendering is + /// disabled. /// void(CEF_CALLBACK* drag_source_ended_at)(struct _cef_browser_host_t* self, int x, @@ -823,55 +829,55 @@ typedef struct _cef_browser_host_t { cef_drag_operations_mask_t op); /// - // Call this function when the drag operation started by a - // cef_render_handler_t::StartDragging call has completed. This function may - // be called immediately without first calling DragSourceEndedAt to cancel a - // drag operation. If the web view is both the drag source and the drag target - // then all DragTarget* functions should be called before DragSource* mthods. - // This function is only used when window rendering is disabled. + /// Call this function when the drag operation started by a + /// cef_render_handler_t::StartDragging call has completed. This function may + /// be called immediately without first calling DragSourceEndedAt to cancel a + /// drag operation. If the web view is both the drag source and the drag + /// target then all DragTarget* functions should be called before DragSource* + /// mthods. This function is only used when window rendering is disabled. /// void(CEF_CALLBACK* drag_source_system_drag_ended)( struct _cef_browser_host_t* self); /// - // Returns the current visible navigation entry for this browser. This - // function can only be called on the UI thread. + /// Returns the current visible navigation entry for this browser. This + /// function can only be called on the UI thread. /// struct _cef_navigation_entry_t*(CEF_CALLBACK* get_visible_navigation_entry)( struct _cef_browser_host_t* self); /// - // Set accessibility state for all frames. |accessibility_state| may be - // default, enabled or disabled. If |accessibility_state| is STATE_DEFAULT - // then accessibility will be disabled by default and the state may be further - // controlled with the "force-renderer-accessibility" and "disable-renderer- - // accessibility" command-line switches. If |accessibility_state| is - // STATE_ENABLED then accessibility will be enabled. If |accessibility_state| - // is STATE_DISABLED then accessibility will be completely disabled. - // - // For windowed browsers accessibility will be enabled in Complete mode (which - // corresponds to kAccessibilityModeComplete in Chromium). In this mode all - // platform accessibility objects will be created and managed by Chromium's - // internal implementation. The client needs only to detect the screen reader - // and call this function appropriately. For example, on macOS the client can - // handle the @"AXEnhancedUserStructure" accessibility attribute to detect - // VoiceOver state changes and on Windows the client can handle WM_GETOBJECT - // with OBJID_CLIENT to detect accessibility readers. - // - // For windowless browsers accessibility will be enabled in TreeOnly mode - // (which corresponds to kAccessibilityModeWebContentsOnly in Chromium). In - // this mode renderer accessibility is enabled, the full tree is computed, and - // events are passed to CefAccessibiltyHandler, but platform accessibility - // objects are not created. The client may implement platform accessibility - // objects using CefAccessibiltyHandler callbacks if desired. + /// Set accessibility state for all frames. |accessibility_state| may be + /// default, enabled or disabled. If |accessibility_state| is STATE_DEFAULT + /// then accessibility will be disabled by default and the state may be + /// further controlled with the "force-renderer-accessibility" and "disable- + /// renderer-accessibility" command-line switches. If |accessibility_state| is + /// STATE_ENABLED then accessibility will be enabled. If |accessibility_state| + /// is STATE_DISABLED then accessibility will be completely disabled. + /// + /// For windowed browsers accessibility will be enabled in Complete mode + /// (which corresponds to kAccessibilityModeComplete in Chromium). In this + /// mode all platform accessibility objects will be created and managed by + /// Chromium's internal implementation. The client needs only to detect the + /// screen reader and call this function appropriately. For example, on macOS + /// the client can handle the @"AXEnhancedUserStructure" accessibility + /// attribute to detect VoiceOver state changes and on Windows the client can + /// handle WM_GETOBJECT with OBJID_CLIENT to detect accessibility readers. + /// + /// For windowless browsers accessibility will be enabled in TreeOnly mode + /// (which corresponds to kAccessibilityModeWebContentsOnly in Chromium). In + /// this mode renderer accessibility is enabled, the full tree is computed, + /// and events are passed to CefAccessibiltyHandler, but platform + /// accessibility objects are not created. The client may implement platform + /// accessibility objects using CefAccessibiltyHandler callbacks if desired. /// void(CEF_CALLBACK* set_accessibility_state)(struct _cef_browser_host_t* self, cef_state_t accessibility_state); /// - // Enable notifications of auto resize via - // cef_display_handler_t::OnAutoResize. Notifications are disabled by default. - // |min_size| and |max_size| define the range of allowed sizes. + /// Enable notifications of auto resize via + /// cef_display_handler_t::OnAutoResize. Notifications are disabled by + /// default. |min_size| and |max_size| define the range of allowed sizes. /// void(CEF_CALLBACK* set_auto_resize_enabled)(struct _cef_browser_host_t* self, int enabled, @@ -879,41 +885,41 @@ typedef struct _cef_browser_host_t { const cef_size_t* max_size); /// - // Returns the extension hosted in this browser or NULL if no extension is - // hosted. See cef_request_context_t::LoadExtension for details. + /// Returns the extension hosted in this browser or NULL if no extension is + /// hosted. See cef_request_context_t::LoadExtension for details. /// struct _cef_extension_t*(CEF_CALLBACK* get_extension)( struct _cef_browser_host_t* self); /// - // Returns true (1) if this browser is hosting an extension background script. - // Background hosts do not have a window and are not displayable. See - // cef_request_context_t::LoadExtension for details. + /// Returns true (1) if this browser is hosting an extension background + /// script. Background hosts do not have a window and are not displayable. See + /// cef_request_context_t::LoadExtension for details. /// int(CEF_CALLBACK* is_background_host)(struct _cef_browser_host_t* self); /// - // Set whether the browser's audio is muted. + /// Set whether the browser's audio is muted. /// void(CEF_CALLBACK* set_audio_muted)(struct _cef_browser_host_t* self, int mute); /// - // Returns true (1) if the browser's audio is muted. This function can only - // be called on the UI thread. + /// Returns true (1) if the browser's audio is muted. This function can only + /// be called on the UI thread. /// int(CEF_CALLBACK* is_audio_muted)(struct _cef_browser_host_t* self); } cef_browser_host_t; /// -// Create a new browser using the window parameters specified by |windowInfo|. -// All values will be copied internally and the actual window (if any) will be -// created on the UI thread. If |request_context| is NULL the global request -// context will be used. This function can be called on any browser process -// thread and will not block. The optional |extra_info| parameter provides an -// opportunity to specify extra information specific to the created browser that -// will be passed to cef_render_process_handler_t::on_browser_created() in the -// render process. +/// Create a new browser using the window parameters specified by |windowInfo|. +/// All values will be copied internally and the actual window (if any) will be +/// created on the UI thread. If |request_context| is NULL the global request +/// context will be used. This function can be called on any browser process +/// thread and will not block. The optional |extra_info| parameter provides an +/// opportunity to specify extra information specific to the created browser +/// that will be passed to cef_render_process_handler_t::on_browser_created() in +/// the render process. /// CEF_EXPORT int cef_browser_host_create_browser( const cef_window_info_t* windowInfo, @@ -924,12 +930,12 @@ CEF_EXPORT int cef_browser_host_create_browser( struct _cef_request_context_t* request_context); /// -// Create a new browser using the window parameters specified by |windowInfo|. -// If |request_context| is NULL the global request context will be used. This -// function can only be called on the browser process UI thread. The optional -// |extra_info| parameter provides an opportunity to specify extra information -// specific to the created browser that will be passed to -// cef_render_process_handler_t::on_browser_created() in the render process. +/// Create a new browser using the window parameters specified by |windowInfo|. +/// If |request_context| is NULL the global request context will be used. This +/// function can only be called on the browser process UI thread. The optional +/// |extra_info| parameter provides an opportunity to specify extra information +/// specific to the created browser that will be passed to +/// cef_render_process_handler_t::on_browser_created() in the render process. /// CEF_EXPORT cef_browser_t* cef_browser_host_create_browser_sync( const cef_window_info_t* windowInfo, diff --git a/include/capi/cef_browser_process_handler_capi.h b/include/capi/cef_browser_process_handler_capi.h index 564e802db..c1e121c45 100644 --- a/include/capi/cef_browser_process_handler_capi.h +++ b/include/capi/cef_browser_process_handler_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=ad0a78715daff99c1ec987800b7e5d62196e7100$ +// $hash=c4ed4278e513daa2a1ccf42e50e242d61dfbb86f$ // #ifndef CEF_INCLUDE_CAPI_CEF_BROWSER_PROCESS_HANDLER_CAPI_H_ @@ -50,57 +50,57 @@ extern "C" { #endif /// -// Structure used to implement browser process callbacks. The functions of this -// structure will be called on the browser process main thread unless otherwise -// indicated. +/// Structure used to implement browser process callbacks. The functions of this +/// structure will be called on the browser process main thread unless otherwise +/// indicated. /// typedef struct _cef_browser_process_handler_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called on the browser process UI thread immediately after the CEF context - // has been initialized. + /// Called on the browser process UI thread immediately after the CEF context + /// has been initialized. /// void(CEF_CALLBACK* on_context_initialized)( struct _cef_browser_process_handler_t* self); /// - // Called before a child process is launched. Will be called on the browser - // process UI thread when launching a render process and on the browser - // process IO thread when launching a GPU process. Provides an opportunity to - // modify the child process command line. Do not keep a reference to - // |command_line| outside of this function. + /// Called before a child process is launched. Will be called on the browser + /// process UI thread when launching a render process and on the browser + /// process IO thread when launching a GPU process. Provides an opportunity to + /// modify the child process command line. Do not keep a reference to + /// |command_line| outside of this function. /// void(CEF_CALLBACK* on_before_child_process_launch)( struct _cef_browser_process_handler_t* self, struct _cef_command_line_t* command_line); /// - // Called from any thread when work has been scheduled for the browser process - // main (UI) thread. This callback is used in combination with CefSettings. - // external_message_pump and cef_do_message_loop_work() in cases where the CEF - // message loop must be integrated into an existing application message loop - // (see additional comments and warnings on CefDoMessageLoopWork). This - // callback should schedule a cef_do_message_loop_work() call to happen on the - // main (UI) thread. |delay_ms| is the requested delay in milliseconds. If - // |delay_ms| is <= 0 then the call should happen reasonably soon. If - // |delay_ms| is > 0 then the call should be scheduled to happen after the - // specified delay and any currently pending scheduled call should be - // cancelled. + /// Called from any thread when work has been scheduled for the browser + /// process main (UI) thread. This callback is used in combination with + /// cef_settings_t.external_message_pump and cef_do_message_loop_work() in + /// cases where the CEF message loop must be integrated into an existing + /// application message loop (see additional comments and warnings on + /// CefDoMessageLoopWork). This callback should schedule a + /// cef_do_message_loop_work() call to happen on the main (UI) thread. + /// |delay_ms| is the requested delay in milliseconds. If |delay_ms| is <= 0 + /// then the call should happen reasonably soon. If |delay_ms| is > 0 then the + /// call should be scheduled to happen after the specified delay and any + /// currently pending scheduled call should be cancelled. /// void(CEF_CALLBACK* on_schedule_message_pump_work)( struct _cef_browser_process_handler_t* self, int64 delay_ms); /// - // Return the default client for use with a newly created browser window. If - // null is returned the browser will be unmanaged (no callbacks will be - // executed for that browser) and application shutdown will be blocked until - // the browser window is closed manually. This function is currently only used - // with the chrome runtime. + /// Return the default client for use with a newly created browser window. If + /// null is returned the browser will be unmanaged (no callbacks will be + /// executed for that browser) and application shutdown will be blocked until + /// the browser window is closed manually. This function is currently only + /// used with the chrome runtime. /// struct _cef_client_t*(CEF_CALLBACK* get_default_client)( struct _cef_browser_process_handler_t* self); diff --git a/include/capi/cef_callback_capi.h b/include/capi/cef_callback_capi.h index 1ece08781..a91da31d8 100644 --- a/include/capi/cef_callback_capi.h +++ b/include/capi/cef_callback_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=10ef5088ce2a5c6ffb38f8864d3aad6e5ac88b40$ +// $hash=1bb026d01d1d4bb38ceb4c54f6bcf70300bf5201$ // #ifndef CEF_INCLUDE_CAPI_CEF_CALLBACK_CAPI_H_ @@ -47,36 +47,36 @@ extern "C" { #endif /// -// Generic callback structure used for asynchronous continuation. +/// Generic callback structure used for asynchronous continuation. /// typedef struct _cef_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Continue processing. + /// Continue processing. /// void(CEF_CALLBACK* cont)(struct _cef_callback_t* self); /// - // Cancel processing. + /// Cancel processing. /// void(CEF_CALLBACK* cancel)(struct _cef_callback_t* self); } cef_callback_t; /// -// Generic callback structure used for asynchronous completion. +/// Generic callback structure used for asynchronous completion. /// typedef struct _cef_completion_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Method that will be called once the task is complete. + /// Method that will be called once the task is complete. /// void(CEF_CALLBACK* on_complete)(struct _cef_completion_callback_t* self); } cef_completion_callback_t; diff --git a/include/capi/cef_client_capi.h b/include/capi/cef_client_capi.h index 6bd4837d6..3c33a1d78 100644 --- a/include/capi/cef_client_capi.h +++ b/include/capi/cef_client_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=03ae4ba9762510e2b0c19ea29322c20ebaf2e683$ +// $hash=93f1c39c102dc97d6ad8d236a90a2e0e88f10fb7$ // #ifndef CEF_INCLUDE_CAPI_CEF_CLIENT_CAPI_H_ @@ -66,134 +66,134 @@ extern "C" { #endif /// -// Implement this structure to provide handler implementations. +/// Implement this structure to provide handler implementations. /// typedef struct _cef_client_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Return the handler for audio rendering events. + /// Return the handler for audio rendering events. /// struct _cef_audio_handler_t*(CEF_CALLBACK* get_audio_handler)( struct _cef_client_t* self); /// - // Return the handler for commands. If no handler is provided the default - // implementation will be used. + /// Return the handler for commands. If no handler is provided the default + /// implementation will be used. /// struct _cef_command_handler_t*(CEF_CALLBACK* get_command_handler)( struct _cef_client_t* self); /// - // Return the handler for context menus. If no handler is provided the default - // implementation will be used. + /// Return the handler for context menus. If no handler is provided the + /// default implementation will be used. /// struct _cef_context_menu_handler_t*(CEF_CALLBACK* get_context_menu_handler)( struct _cef_client_t* self); /// - // Return the handler for dialogs. If no handler is provided the default - // implementation will be used. + /// Return the handler for dialogs. If no handler is provided the default + /// implementation will be used. /// struct _cef_dialog_handler_t*(CEF_CALLBACK* get_dialog_handler)( struct _cef_client_t* self); /// - // Return the handler for browser display state events. + /// Return the handler for browser display state events. /// struct _cef_display_handler_t*(CEF_CALLBACK* get_display_handler)( struct _cef_client_t* self); /// - // Return the handler for download events. If no handler is returned downloads - // will not be allowed. + /// Return the handler for download events. If no handler is returned + /// downloads will not be allowed. /// struct _cef_download_handler_t*(CEF_CALLBACK* get_download_handler)( struct _cef_client_t* self); /// - // Return the handler for drag events. + /// Return the handler for drag events. /// struct _cef_drag_handler_t*(CEF_CALLBACK* get_drag_handler)( struct _cef_client_t* self); /// - // Return the handler for find result events. + /// Return the handler for find result events. /// struct _cef_find_handler_t*(CEF_CALLBACK* get_find_handler)( struct _cef_client_t* self); /// - // Return the handler for focus events. + /// Return the handler for focus events. /// struct _cef_focus_handler_t*(CEF_CALLBACK* get_focus_handler)( struct _cef_client_t* self); /// - // Return the handler for events related to cef_frame_t lifespan. This - // function will be called once during cef_browser_t creation and the result - // will be cached for performance reasons. + /// Return the handler for events related to cef_frame_t lifespan. This + /// function will be called once during cef_browser_t creation and the result + /// will be cached for performance reasons. /// struct _cef_frame_handler_t*(CEF_CALLBACK* get_frame_handler)( struct _cef_client_t* self); /// - // Return the handler for permission requests. + /// Return the handler for permission requests. /// struct _cef_permission_handler_t*(CEF_CALLBACK* get_permission_handler)( struct _cef_client_t* self); /// - // Return the handler for JavaScript dialogs. If no handler is provided the - // default implementation will be used. + /// Return the handler for JavaScript dialogs. If no handler is provided the + /// default implementation will be used. /// struct _cef_jsdialog_handler_t*(CEF_CALLBACK* get_jsdialog_handler)( struct _cef_client_t* self); /// - // Return the handler for keyboard events. + /// Return the handler for keyboard events. /// struct _cef_keyboard_handler_t*(CEF_CALLBACK* get_keyboard_handler)( struct _cef_client_t* self); /// - // Return the handler for browser life span events. + /// Return the handler for browser life span events. /// struct _cef_life_span_handler_t*(CEF_CALLBACK* get_life_span_handler)( struct _cef_client_t* self); /// - // Return the handler for browser load status events. + /// Return the handler for browser load status events. /// struct _cef_load_handler_t*(CEF_CALLBACK* get_load_handler)( struct _cef_client_t* self); /// - // Return the handler for printing on Linux. If a print handler is not - // provided then printing will not be supported on the Linux platform. + /// Return the handler for printing on Linux. If a print handler is not + /// provided then printing will not be supported on the Linux platform. /// struct _cef_print_handler_t*(CEF_CALLBACK* get_print_handler)( struct _cef_client_t* self); /// - // Return the handler for off-screen rendering events. + /// Return the handler for off-screen rendering events. /// struct _cef_render_handler_t*(CEF_CALLBACK* get_render_handler)( struct _cef_client_t* self); /// - // Return the handler for browser request events. + /// Return the handler for browser request events. /// struct _cef_request_handler_t*(CEF_CALLBACK* get_request_handler)( struct _cef_client_t* self); /// - // Called when a new message is received from a different process. Return true - // (1) if the message was handled or false (0) otherwise. It is safe to keep - // a reference to |message| outside of this callback. + /// Called when a new message is received from a different process. Return + /// true (1) if the message was handled or false (0) otherwise. It is safe to + /// keep a reference to |message| outside of this callback. /// int(CEF_CALLBACK* on_process_message_received)( struct _cef_client_t* self, diff --git a/include/capi/cef_command_handler_capi.h b/include/capi/cef_command_handler_capi.h index f58faf30d..dea127bed 100644 --- a/include/capi/cef_command_handler_capi.h +++ b/include/capi/cef_command_handler_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=54332b79c057df9c8f3be56cc77f1daf877b3ac1$ +// $hash=ec05ae57537091e3543c4b31d72d2d84d44df876$ // #ifndef CEF_INCLUDE_CAPI_CEF_COMMAND_HANDLER_CAPI_H_ @@ -48,23 +48,23 @@ extern "C" { #endif /// -// Implement this structure to handle events related to commands. The functions -// of this structure will be called on the UI thread. +/// Implement this structure to handle events related to commands. The functions +/// of this structure will be called on the UI thread. /// typedef struct _cef_command_handler_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called to execute a Chrome command triggered via menu selection or keyboard - // shortcut. Values for |command_id| can be found in the cef_command_ids.h - // file. |disposition| provides information about the intended command target. - // Return true (1) if the command was handled or false (0) for the default - // implementation. For context menu commands this will be called after - // cef_context_menu_handler_t::OnContextMenuCommand. Only used with the Chrome - // runtime. + /// Called to execute a Chrome command triggered via menu selection or + /// keyboard shortcut. Values for |command_id| can be found in the + /// cef_command_ids.h file. |disposition| provides information about the + /// intended command target. Return true (1) if the command was handled or + /// false (0) for the default implementation. For context menu commands this + /// will be called after cef_context_menu_handler_t::OnContextMenuCommand. + /// Only used with the Chrome runtime. /// int(CEF_CALLBACK* on_chrome_command)( struct _cef_command_handler_t* self, diff --git a/include/capi/cef_command_line_capi.h b/include/capi/cef_command_line_capi.h index 6a4a832df..7af3177bf 100644 --- a/include/capi/cef_command_line_capi.h +++ b/include/capi/cef_command_line_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=3049c9960a95d32d61cc57ae998c0eba12820673$ +// $hash=f535e9560b9fde9b53fc4d8383905105ed029ea4$ // #ifndef CEF_INCLUDE_CAPI_CEF_COMMAND_LINE_CAPI_H_ @@ -47,104 +47,104 @@ extern "C" { #endif /// -// Structure used to create and/or parse command line arguments. Arguments with -// '--', '-' and, on Windows, '/' prefixes are considered switches. Switches -// will always precede any arguments without switch prefixes. Switches can -// optionally have a value specified using the '=' delimiter (e.g. -// "-switch=value"). An argument of "--" will terminate switch parsing with all -// subsequent tokens, regardless of prefix, being interpreted as non-switch -// arguments. Switch names should be lowercase ASCII and will be converted to -// such if necessary. Switch values will retain the original case and UTF8 -// encoding. This structure can be used before cef_initialize() is called. +/// Structure used to create and/or parse command line arguments. Arguments with +/// "--", "-" and, on Windows, "/" prefixes are considered switches. Switches +/// will always precede any arguments without switch prefixes. Switches can +/// optionally have a value specified using the "=" delimiter (e.g. +/// "-switch=value"). An argument of "--" will terminate switch parsing with all +/// subsequent tokens, regardless of prefix, being interpreted as non-switch +/// arguments. Switch names should be lowercase ASCII and will be converted to +/// such if necessary. Switch values will retain the original case and UTF8 +/// encoding. This structure can be used before cef_initialize() is called. /// typedef struct _cef_command_line_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Returns true (1) if this object is valid. Do not call any other functions - // if this function returns false (0). + /// Returns true (1) if this object is valid. Do not call any other functions + /// if this function returns false (0). /// int(CEF_CALLBACK* is_valid)(struct _cef_command_line_t* self); /// - // Returns true (1) if the values of this object are read-only. Some APIs may - // expose read-only objects. + /// Returns true (1) if the values of this object are read-only. Some APIs may + /// expose read-only objects. /// int(CEF_CALLBACK* is_read_only)(struct _cef_command_line_t* self); /// - // Returns a writable copy of this object. + /// Returns a writable copy of this object. /// struct _cef_command_line_t*(CEF_CALLBACK* copy)( struct _cef_command_line_t* self); /// - // Initialize the command line with the specified |argc| and |argv| values. - // The first argument must be the name of the program. This function is only - // supported on non-Windows platforms. + /// Initialize the command line with the specified |argc| and |argv| values. + /// The first argument must be the name of the program. This function is only + /// supported on non-Windows platforms. /// void(CEF_CALLBACK* init_from_argv)(struct _cef_command_line_t* self, int argc, const char* const* argv); /// - // Initialize the command line with the string returned by calling - // GetCommandLineW(). This function is only supported on Windows. + /// Initialize the command line with the string returned by calling + /// GetCommandLineW(). This function is only supported on Windows. /// void(CEF_CALLBACK* init_from_string)(struct _cef_command_line_t* self, const cef_string_t* command_line); /// - // Reset the command-line switches and arguments but leave the program - // component unchanged. + /// Reset the command-line switches and arguments but leave the program + /// component unchanged. /// void(CEF_CALLBACK* reset)(struct _cef_command_line_t* self); /// - // Retrieve the original command line string as a vector of strings. The argv - // array: { program, [(--|-|/)switch[=value]]*, [--], [argument]* } + /// Retrieve the original command line string as a vector of strings. The argv + /// array: `{ program, [(--|-|/)switch[=value]]*, [--], [argument]* }` /// void(CEF_CALLBACK* get_argv)(struct _cef_command_line_t* self, cef_string_list_t argv); /// - // Constructs and returns the represented command line string. Use this - // function cautiously because quoting behavior is unclear. + /// Constructs and returns the represented command line string. Use this + /// function cautiously because quoting behavior is unclear. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_command_line_string)( struct _cef_command_line_t* self); /// - // Get the program part of the command line string (the first item). + /// Get the program part of the command line string (the first item). /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_program)( struct _cef_command_line_t* self); /// - // Set the program part of the command line string (the first item). + /// Set the program part of the command line string (the first item). /// void(CEF_CALLBACK* set_program)(struct _cef_command_line_t* self, const cef_string_t* program); /// - // Returns true (1) if the command line has switches. + /// Returns true (1) if the command line has switches. /// int(CEF_CALLBACK* has_switches)(struct _cef_command_line_t* self); /// - // Returns true (1) if the command line contains the given switch. + /// Returns true (1) if the command line contains the given switch. /// int(CEF_CALLBACK* has_switch)(struct _cef_command_line_t* self, const cef_string_t* name); /// - // Returns the value associated with the given switch. If the switch has no - // value or isn't present this function returns the NULL string. + /// Returns the value associated with the given switch. If the switch has no + /// value or isn't present this function returns the NULL string. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_switch_value)( @@ -152,59 +152,59 @@ typedef struct _cef_command_line_t { const cef_string_t* name); /// - // Returns the map of switch names and values. If a switch has no value an - // NULL string is returned. + /// Returns the map of switch names and values. If a switch has no value an + /// NULL string is returned. /// void(CEF_CALLBACK* get_switches)(struct _cef_command_line_t* self, cef_string_map_t switches); /// - // Add a switch to the end of the command line. If the switch has no value - // pass an NULL value string. + /// Add a switch to the end of the command line. If the switch has no value + /// pass an NULL value string. /// void(CEF_CALLBACK* append_switch)(struct _cef_command_line_t* self, const cef_string_t* name); /// - // Add a switch with the specified value to the end of the command line. + /// Add a switch with the specified value to the end of the command line. /// void(CEF_CALLBACK* append_switch_with_value)(struct _cef_command_line_t* self, const cef_string_t* name, const cef_string_t* value); /// - // True if there are remaining command line arguments. + /// True if there are remaining command line arguments. /// int(CEF_CALLBACK* has_arguments)(struct _cef_command_line_t* self); /// - // Get the remaining command line arguments. + /// Get the remaining command line arguments. /// void(CEF_CALLBACK* get_arguments)(struct _cef_command_line_t* self, cef_string_list_t arguments); /// - // Add an argument to the end of the command line. + /// Add an argument to the end of the command line. /// void(CEF_CALLBACK* append_argument)(struct _cef_command_line_t* self, const cef_string_t* argument); /// - // Insert a command before the current command. Common for debuggers, like - // "valgrind" or "gdb --args". + /// Insert a command before the current command. Common for debuggers, like + /// "valgrind" or "gdb --args". /// void(CEF_CALLBACK* prepend_wrapper)(struct _cef_command_line_t* self, const cef_string_t* wrapper); } cef_command_line_t; /// -// Create a new cef_command_line_t instance. +/// Create a new cef_command_line_t instance. /// CEF_EXPORT cef_command_line_t* cef_command_line_create(void); /// -// Returns the singleton global cef_command_line_t object. The returned object -// will be read-only. +/// Returns the singleton global cef_command_line_t object. The returned object +/// will be read-only. /// CEF_EXPORT cef_command_line_t* cef_command_line_get_global(void); diff --git a/include/capi/cef_context_menu_handler_capi.h b/include/capi/cef_context_menu_handler_capi.h index a8053d938..e16ae5bff 100644 --- a/include/capi/cef_context_menu_handler_capi.h +++ b/include/capi/cef_context_menu_handler_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=d9498ae2e32ec124df3dd2c3017bcf415d4205f8$ +// $hash=0ae549ed35e30afcbb01961fe55455beaadcd7f9$ // #ifndef CEF_INCLUDE_CAPI_CEF_CONTEXT_MENU_HANDLER_CAPI_H_ @@ -52,67 +52,67 @@ extern "C" { struct _cef_context_menu_params_t; /// -// Callback structure used for continuation of custom context menu display. +/// Callback structure used for continuation of custom context menu display. /// typedef struct _cef_run_context_menu_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Complete context menu display by selecting the specified |command_id| and - // |event_flags|. + /// Complete context menu display by selecting the specified |command_id| and + /// |event_flags|. /// void(CEF_CALLBACK* cont)(struct _cef_run_context_menu_callback_t* self, int command_id, cef_event_flags_t event_flags); /// - // Cancel context menu display. + /// Cancel context menu display. /// void(CEF_CALLBACK* cancel)(struct _cef_run_context_menu_callback_t* self); } cef_run_context_menu_callback_t; /// -// Callback structure used for continuation of custom quick menu display. +/// Callback structure used for continuation of custom quick menu display. /// typedef struct _cef_run_quick_menu_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Complete quick menu display by selecting the specified |command_id| and - // |event_flags|. + /// Complete quick menu display by selecting the specified |command_id| and + /// |event_flags|. /// void(CEF_CALLBACK* cont)(struct _cef_run_quick_menu_callback_t* self, int command_id, cef_event_flags_t event_flags); /// - // Cancel quick menu display. + /// Cancel quick menu display. /// void(CEF_CALLBACK* cancel)(struct _cef_run_quick_menu_callback_t* self); } cef_run_quick_menu_callback_t; /// -// Implement this structure to handle context menu events. The functions of this -// structure will be called on the UI thread. +/// Implement this structure to handle context menu events. The functions of +/// this structure will be called on the UI thread. /// typedef struct _cef_context_menu_handler_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called before a context menu is displayed. |params| provides information - // about the context menu state. |model| initially contains the default - // context menu. The |model| can be cleared to show no context menu or - // modified to show a custom menu. Do not keep references to |params| or - // |model| outside of this callback. + /// Called before a context menu is displayed. |params| provides information + /// about the context menu state. |model| initially contains the default + /// context menu. The |model| can be cleared to show no context menu or + /// modified to show a custom menu. Do not keep references to |params| or + /// |model| outside of this callback. /// void(CEF_CALLBACK* on_before_context_menu)( struct _cef_context_menu_handler_t* self, @@ -122,12 +122,12 @@ typedef struct _cef_context_menu_handler_t { struct _cef_menu_model_t* model); /// - // Called to allow custom display of the context menu. |params| provides - // information about the context menu state. |model| contains the context menu - // model resulting from OnBeforeContextMenu. For custom display return true - // (1) and execute |callback| either synchronously or asynchronously with the - // selected command ID. For default display return false (0). Do not keep - // references to |params| or |model| outside of this callback. + /// Called to allow custom display of the context menu. |params| provides + /// information about the context menu state. |model| contains the context + /// menu model resulting from OnBeforeContextMenu. For custom display return + /// true (1) and execute |callback| either synchronously or asynchronously + /// with the selected command ID. For default display return false (0). Do not + /// keep references to |params| or |model| outside of this callback. /// int(CEF_CALLBACK* run_context_menu)( struct _cef_context_menu_handler_t* self, @@ -138,13 +138,13 @@ typedef struct _cef_context_menu_handler_t { struct _cef_run_context_menu_callback_t* callback); /// - // Called to execute a command selected from the context menu. Return true (1) - // if the command was handled or false (0) for the default implementation. See - // cef_menu_id_t for the command ids that have default implementations. All - // user-defined command ids should be between MENU_ID_USER_FIRST and - // MENU_ID_USER_LAST. |params| will have the same values as what was passed to - // on_before_context_menu(). Do not keep a reference to |params| outside of - // this callback. + /// Called to execute a command selected from the context menu. Return true + /// (1) if the command was handled or false (0) for the default + /// implementation. See cef_menu_id_t for the command ids that have default + /// implementations. All user-defined command ids should be between + /// MENU_ID_USER_FIRST and MENU_ID_USER_LAST. |params| will have the same + /// values as what was passed to on_before_context_menu(). Do not keep a + /// reference to |params| outside of this callback. /// int(CEF_CALLBACK* on_context_menu_command)( struct _cef_context_menu_handler_t* self, @@ -155,8 +155,8 @@ typedef struct _cef_context_menu_handler_t { cef_event_flags_t event_flags); /// - // Called when the context menu is dismissed irregardless of whether the menu - // was canceled or a command was selected. + /// Called when the context menu is dismissed irregardless of whether the menu + /// was canceled or a command was selected. /// void(CEF_CALLBACK* on_context_menu_dismissed)( struct _cef_context_menu_handler_t* self, @@ -164,13 +164,13 @@ typedef struct _cef_context_menu_handler_t { struct _cef_frame_t* frame); /// - // Called to allow custom display of the quick menu for a windowless browser. - // |location| is the top left corner of the selected region. |size| is the - // size of the selected region. |edit_state_flags| is a combination of flags - // that represent the state of the quick menu. Return true (1) if the menu - // will be handled and execute |callback| either synchronously or - // asynchronously with the selected command ID. Return false (0) to cancel the - // menu. + /// Called to allow custom display of the quick menu for a windowless browser. + /// |location| is the top left corner of the selected region. |size| is the + /// size of the selected region. |edit_state_flags| is a combination of flags + /// that represent the state of the quick menu. Return true (1) if the menu + /// will be handled and execute |callback| either synchronously or + /// asynchronously with the selected command ID. Return false (0) to cancel + /// the menu. /// int(CEF_CALLBACK* run_quick_menu)( struct _cef_context_menu_handler_t* self, @@ -182,10 +182,10 @@ typedef struct _cef_context_menu_handler_t { struct _cef_run_quick_menu_callback_t* callback); /// - // Called to execute a command selected from the quick menu for a windowless - // browser. Return true (1) if the command was handled or false (0) for the - // default implementation. See cef_menu_id_t for command IDs that have default - // implementations. + /// Called to execute a command selected from the quick menu for a windowless + /// browser. Return true (1) if the command was handled or false (0) for the + /// default implementation. See cef_menu_id_t for command IDs that have + /// default implementations. /// int(CEF_CALLBACK* on_quick_menu_command)( struct _cef_context_menu_handler_t* self, @@ -195,8 +195,8 @@ typedef struct _cef_context_menu_handler_t { cef_event_flags_t event_flags); /// - // Called when the quick menu for a windowless browser is dismissed - // irregardless of whether the menu was canceled or a command was selected. + /// Called when the quick menu for a windowless browser is dismissed + /// irregardless of whether the menu was canceled or a command was selected. /// void(CEF_CALLBACK* on_quick_menu_dismissed)( struct _cef_context_menu_handler_t* self, @@ -205,155 +205,157 @@ typedef struct _cef_context_menu_handler_t { } cef_context_menu_handler_t; /// -// Provides information about the context menu state. The functions of this -// structure can only be accessed on browser process the UI thread. +/// Provides information about the context menu state. The functions of this +/// structure can only be accessed on browser process the UI thread. /// typedef struct _cef_context_menu_params_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Returns the X coordinate of the mouse where the context menu was invoked. - // Coords are relative to the associated RenderView's origin. + /// Returns the X coordinate of the mouse where the context menu was invoked. + /// Coords are relative to the associated RenderView's origin. /// int(CEF_CALLBACK* get_xcoord)(struct _cef_context_menu_params_t* self); /// - // Returns the Y coordinate of the mouse where the context menu was invoked. - // Coords are relative to the associated RenderView's origin. + /// Returns the Y coordinate of the mouse where the context menu was invoked. + /// Coords are relative to the associated RenderView's origin. /// int(CEF_CALLBACK* get_ycoord)(struct _cef_context_menu_params_t* self); /// - // Returns flags representing the type of node that the context menu was - // invoked on. + /// Returns flags representing the type of node that the context menu was + /// invoked on. /// cef_context_menu_type_flags_t(CEF_CALLBACK* get_type_flags)( struct _cef_context_menu_params_t* self); /// - // Returns the URL of the link, if any, that encloses the node that the - // context menu was invoked on. + /// Returns the URL of the link, if any, that encloses the node that the + /// context menu was invoked on. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_link_url)( struct _cef_context_menu_params_t* self); /// - // Returns the link URL, if any, to be used ONLY for "copy link address". We - // don't validate this field in the frontend process. + /// Returns the link URL, if any, to be used ONLY for "copy link address". We + /// don't validate this field in the frontend process. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_unfiltered_link_url)( struct _cef_context_menu_params_t* self); /// - // Returns the source URL, if any, for the element that the context menu was - // invoked on. Example of elements with source URLs are img, audio, and video. + /// Returns the source URL, if any, for the element that the context menu was + /// invoked on. Example of elements with source URLs are img, audio, and + /// video. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_source_url)( struct _cef_context_menu_params_t* self); /// - // Returns true (1) if the context menu was invoked on an image which has non- - // NULL contents. + /// Returns true (1) if the context menu was invoked on an image which has + /// non-NULL contents. /// int(CEF_CALLBACK* has_image_contents)( struct _cef_context_menu_params_t* self); /// - // Returns the title text or the alt text if the context menu was invoked on - // an image. + /// Returns the title text or the alt text if the context menu was invoked on + /// an image. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_title_text)( struct _cef_context_menu_params_t* self); /// - // Returns the URL of the top level page that the context menu was invoked on. + /// Returns the URL of the top level page that the context menu was invoked + /// on. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_page_url)( struct _cef_context_menu_params_t* self); /// - // Returns the URL of the subframe that the context menu was invoked on. + /// Returns the URL of the subframe that the context menu was invoked on. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_frame_url)( struct _cef_context_menu_params_t* self); /// - // Returns the character encoding of the subframe that the context menu was - // invoked on. + /// Returns the character encoding of the subframe that the context menu was + /// invoked on. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_frame_charset)( struct _cef_context_menu_params_t* self); /// - // Returns the type of context node that the context menu was invoked on. + /// Returns the type of context node that the context menu was invoked on. /// cef_context_menu_media_type_t(CEF_CALLBACK* get_media_type)( struct _cef_context_menu_params_t* self); /// - // Returns flags representing the actions supported by the media element, if - // any, that the context menu was invoked on. + /// Returns flags representing the actions supported by the media element, if + /// any, that the context menu was invoked on. /// cef_context_menu_media_state_flags_t(CEF_CALLBACK* get_media_state_flags)( struct _cef_context_menu_params_t* self); /// - // Returns the text of the selection, if any, that the context menu was - // invoked on. + /// Returns the text of the selection, if any, that the context menu was + /// invoked on. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_selection_text)( struct _cef_context_menu_params_t* self); /// - // Returns the text of the misspelled word, if any, that the context menu was - // invoked on. + /// Returns the text of the misspelled word, if any, that the context menu was + /// invoked on. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_misspelled_word)( struct _cef_context_menu_params_t* self); /// - // Returns true (1) if suggestions exist, false (0) otherwise. Fills in - // |suggestions| from the spell check service for the misspelled word if there - // is one. + /// Returns true (1) if suggestions exist, false (0) otherwise. Fills in + /// |suggestions| from the spell check service for the misspelled word if + /// there is one. /// int(CEF_CALLBACK* get_dictionary_suggestions)( struct _cef_context_menu_params_t* self, cef_string_list_t suggestions); /// - // Returns true (1) if the context menu was invoked on an editable node. + /// Returns true (1) if the context menu was invoked on an editable node. /// int(CEF_CALLBACK* is_editable)(struct _cef_context_menu_params_t* self); /// - // Returns true (1) if the context menu was invoked on an editable node where - // spell-check is enabled. + /// Returns true (1) if the context menu was invoked on an editable node where + /// spell-check is enabled. /// int(CEF_CALLBACK* is_spell_check_enabled)( struct _cef_context_menu_params_t* self); /// - // Returns flags representing the actions supported by the editable node, if - // any, that the context menu was invoked on. + /// Returns flags representing the actions supported by the editable node, if + /// any, that the context menu was invoked on. /// cef_context_menu_edit_state_flags_t(CEF_CALLBACK* get_edit_state_flags)( struct _cef_context_menu_params_t* self); /// - // Returns true (1) if the context menu contains items specified by the - // renderer process. + /// Returns true (1) if the context menu contains items specified by the + /// renderer process. /// int(CEF_CALLBACK* is_custom_menu)(struct _cef_context_menu_params_t* self); } cef_context_menu_params_t; diff --git a/include/capi/cef_cookie_capi.h b/include/capi/cef_cookie_capi.h index 4d1b7c9f1..4cd5d3631 100644 --- a/include/capi/cef_cookie_capi.h +++ b/include/capi/cef_cookie_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=d9790a35d74621e985b917935a4fca74ba7db1e0$ +// $hash=37b5e115ff7abd1df1b9913404b69505fb9fef29$ // #ifndef CEF_INCLUDE_CAPI_CEF_COOKIE_CAPI_H_ @@ -52,29 +52,29 @@ struct _cef_delete_cookies_callback_t; struct _cef_set_cookie_callback_t; /// -// Structure used for managing cookies. The functions of this structure may be -// called on any thread unless otherwise indicated. +/// Structure used for managing cookies. The functions of this structure may be +/// called on any thread unless otherwise indicated. /// typedef struct _cef_cookie_manager_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Visit all cookies on the UI thread. The returned cookies are ordered by - // longest path, then by earliest creation date. Returns false (0) if cookies - // cannot be accessed. + /// Visit all cookies on the UI thread. The returned cookies are ordered by + /// longest path, then by earliest creation date. Returns false (0) if cookies + /// cannot be accessed. /// int(CEF_CALLBACK* visit_all_cookies)(struct _cef_cookie_manager_t* self, struct _cef_cookie_visitor_t* visitor); /// - // Visit a subset of cookies on the UI thread. The results are filtered by the - // given url scheme, host, domain and path. If |includeHttpOnly| is true (1) - // HTTP-only cookies will also be included in the results. The returned - // cookies are ordered by longest path, then by earliest creation date. - // Returns false (0) if cookies cannot be accessed. + /// Visit a subset of cookies on the UI thread. The results are filtered by + /// the given url scheme, host, domain and path. If |includeHttpOnly| is true + /// (1) HTTP-only cookies will also be included in the results. The returned + /// cookies are ordered by longest path, then by earliest creation date. + /// Returns false (0) if cookies cannot be accessed. /// int(CEF_CALLBACK* visit_url_cookies)(struct _cef_cookie_manager_t* self, const cef_string_t* url, @@ -82,13 +82,13 @@ typedef struct _cef_cookie_manager_t { struct _cef_cookie_visitor_t* visitor); /// - // Sets a cookie given a valid URL and explicit user-provided cookie - // attributes. This function expects each attribute to be well-formed. It will - // check for disallowed characters (e.g. the ';' character is disallowed - // within the cookie value attribute) and fail without setting the cookie if - // such characters are found. If |callback| is non-NULL it will be executed - // asnychronously on the UI thread after the cookie has been set. Returns - // false (0) if an invalid URL is specified or if cookies cannot be accessed. + /// Sets a cookie given a valid URL and explicit user-provided cookie + /// attributes. This function expects each attribute to be well-formed. It + /// will check for disallowed characters (e.g. the ';' character is disallowed + /// within the cookie value attribute) and fail without setting the cookie if + /// such characters are found. If |callback| is non-NULL it will be executed + /// asnychronously on the UI thread after the cookie has been set. Returns + /// false (0) if an invalid URL is specified or if cookies cannot be accessed. /// int(CEF_CALLBACK* set_cookie)(struct _cef_cookie_manager_t* self, const cef_string_t* url, @@ -96,15 +96,15 @@ typedef struct _cef_cookie_manager_t { struct _cef_set_cookie_callback_t* callback); /// - // Delete all cookies that match the specified parameters. If both |url| and - // |cookie_name| values are specified all host and domain cookies matching - // both will be deleted. If only |url| is specified all host cookies (but not - // domain cookies) irrespective of path will be deleted. If |url| is NULL all - // cookies for all hosts and domains will be deleted. If |callback| is non- - // NULL it will be executed asnychronously on the UI thread after the cookies - // have been deleted. Returns false (0) if a non-NULL invalid URL is specified - // or if cookies cannot be accessed. Cookies can alternately be deleted using - // the Visit*Cookies() functions. + /// Delete all cookies that match the specified parameters. If both |url| and + /// |cookie_name| values are specified all host and domain cookies matching + /// both will be deleted. If only |url| is specified all host cookies (but not + /// domain cookies) irrespective of path will be deleted. If |url| is NULL all + /// cookies for all hosts and domains will be deleted. If |callback| is non- + /// NULL it will be executed asnychronously on the UI thread after the cookies + /// have been deleted. Returns false (0) if a non-NULL invalid URL is + /// specified or if cookies cannot be accessed. Cookies can alternately be + /// deleted using the Visit*Cookies() functions. /// int(CEF_CALLBACK* delete_cookies)( struct _cef_cookie_manager_t* self, @@ -113,41 +113,41 @@ typedef struct _cef_cookie_manager_t { struct _cef_delete_cookies_callback_t* callback); /// - // Flush the backing store (if any) to disk. If |callback| is non-NULL it will - // be executed asnychronously on the UI thread after the flush is complete. - // Returns false (0) if cookies cannot be accessed. + /// Flush the backing store (if any) to disk. If |callback| is non-NULL it + /// will be executed asnychronously on the UI thread after the flush is + /// complete. Returns false (0) if cookies cannot be accessed. /// int(CEF_CALLBACK* flush_store)(struct _cef_cookie_manager_t* self, struct _cef_completion_callback_t* callback); } cef_cookie_manager_t; /// -// Returns the global cookie manager. By default data will be stored at -// CefSettings.cache_path if specified or in memory otherwise. If |callback| is -// non-NULL it will be executed asnychronously on the UI thread after the -// manager's storage has been initialized. Using this function is equivalent to -// calling cef_request_context_t::cef_request_context_get_global_context()->GetD -// efaultCookieManager(). +/// Returns the global cookie manager. By default data will be stored at +/// cef_settings_t.cache_path if specified or in memory otherwise. If |callback| +/// is non-NULL it will be executed asnychronously on the UI thread after the +/// manager's storage has been initialized. Using this function is equivalent to +/// calling cef_request_context_t::cef_request_context_get_global_context()->Get +/// DefaultCookieManager(). /// CEF_EXPORT cef_cookie_manager_t* cef_cookie_manager_get_global_manager( struct _cef_completion_callback_t* callback); /// -// Structure to implement for visiting cookie values. The functions of this -// structure will always be called on the UI thread. +/// Structure to implement for visiting cookie values. The functions of this +/// structure will always be called on the UI thread. /// typedef struct _cef_cookie_visitor_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Method that will be called once for each cookie. |count| is the 0-based - // index for the current cookie. |total| is the total number of cookies. Set - // |deleteCookie| to true (1) to delete the cookie currently being visited. - // Return false (0) to stop visiting cookies. This function may never be - // called if no cookies are found. + /// Method that will be called once for each cookie. |count| is the 0-based + /// index for the current cookie. |total| is the total number of cookies. Set + /// |deleteCookie| to true (1) to delete the cookie currently being visited. + /// Return false (0) to stop visiting cookies. This function may never be + /// called if no cookies are found. /// int(CEF_CALLBACK* visit)(struct _cef_cookie_visitor_t* self, const struct _cef_cookie_t* cookie, @@ -157,36 +157,36 @@ typedef struct _cef_cookie_visitor_t { } cef_cookie_visitor_t; /// -// Structure to implement to be notified of asynchronous completion via -// cef_cookie_manager_t::set_cookie(). +/// Structure to implement to be notified of asynchronous completion via +/// cef_cookie_manager_t::set_cookie(). /// typedef struct _cef_set_cookie_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Method that will be called upon completion. |success| will be true (1) if - // the cookie was set successfully. + /// Method that will be called upon completion. |success| will be true (1) if + /// the cookie was set successfully. /// void(CEF_CALLBACK* on_complete)(struct _cef_set_cookie_callback_t* self, int success); } cef_set_cookie_callback_t; /// -// Structure to implement to be notified of asynchronous completion via -// cef_cookie_manager_t::delete_cookies(). +/// Structure to implement to be notified of asynchronous completion via +/// cef_cookie_manager_t::delete_cookies(). /// typedef struct _cef_delete_cookies_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Method that will be called upon completion. |num_deleted| will be the - // number of cookies that were deleted. + /// Method that will be called upon completion. |num_deleted| will be the + /// number of cookies that were deleted. /// void(CEF_CALLBACK* on_complete)(struct _cef_delete_cookies_callback_t* self, int num_deleted); diff --git a/include/capi/cef_crash_util_capi.h b/include/capi/cef_crash_util_capi.h index 75bdaf7cf..3119367b4 100644 --- a/include/capi/cef_crash_util_capi.h +++ b/include/capi/cef_crash_util_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=5d111a67218403f78737f2c4dc92d2fd96dc125d$ +// $hash=1ce19c3213f033ca9059da738102b9b4292d4a06$ // #ifndef CEF_INCLUDE_CAPI_CEF_CRASH_UTIL_CAPI_H_ @@ -47,99 +47,102 @@ extern "C" { #endif /// -// Crash reporting is configured using an INI-style config file named -// "crash_reporter.cfg". On Windows and Linux this file must be placed next to -// the main application executable. On macOS this file must be placed in the -// top-level app bundle Resources directory (e.g. -// ".app/Contents/Resources"). File contents are as follows: -// -// # Comments start with a hash character and must be on their own line. -// -// [Config] -// ProductName= -// ProductVersion= -// AppName= -// ExternalHandler= -// BrowserCrashForwardingEnabled= -// ServerURL= -// RateLimitEnabled= -// MaxUploadsPerDay= -// MaxDatabaseSizeInMb= -// MaxDatabaseAgeInDays= -// -// [CrashKeys] -// my_key1= -// my_key2= -// -// Config section: -// -// If "ProductName" and/or "ProductVersion" are set then the specified values -// will be included in the crash dump metadata. On macOS if these values are set -// to NULL then they will be retrieved from the Info.plist file using the -// "CFBundleName" and "CFBundleShortVersionString" keys respectively. -// -// If "AppName" is set on Windows then crash report information (metrics, -// database and dumps) will be stored locally on disk under the -// "C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data" folder. On other -// platforms the CefSettings.user_data_path value will be used. -// -// If "ExternalHandler" is set on Windows then the specified exe will be -// launched as the crashpad-handler instead of re-launching the main process -// exe. The value can be an absolute path or a path relative to the main exe -// directory. On Linux the CefSettings.browser_subprocess_path value will be -// used. On macOS the existing subprocess app bundle will be used. -// -// If "BrowserCrashForwardingEnabled" is set to true (1) on macOS then browser -// process crashes will be forwarded to the system crash reporter. This results -// in the crash UI dialog being displayed to the user and crash reports being -// logged under "~/Library/Logs/DiagnosticReports". Forwarding of crash reports -// from non-browser processes and Debug builds is always disabled. -// -// If "ServerURL" is set then crashes will be uploaded as a multi-part POST -// request to the specified URL. Otherwise, reports will only be stored locally -// on disk. -// -// If "RateLimitEnabled" is set to true (1) then crash report uploads will be -// rate limited as follows: -// 1. If "MaxUploadsPerDay" is set to a positive value then at most the -// specified number of crashes will be uploaded in each 24 hour period. -// 2. If crash upload fails due to a network or server error then an -// incremental backoff delay up to a maximum of 24 hours will be applied for -// retries. -// 3. If a backoff delay is applied and "MaxUploadsPerDay" is > 1 then the -// "MaxUploadsPerDay" value will be reduced to 1 until the client is -// restarted. This helps to avoid an upload flood when the network or -// server error is resolved. -// Rate limiting is not supported on Linux. -// -// If "MaxDatabaseSizeInMb" is set to a positive value then crash report storage -// on disk will be limited to that size in megabytes. For example, on Windows -// each dump is about 600KB so a "MaxDatabaseSizeInMb" value of 20 equates to -// about 34 crash reports stored on disk. Not supported on Linux. -// -// If "MaxDatabaseAgeInDays" is set to a positive value then crash reports older -// than the specified age in days will be deleted. Not supported on Linux. -// -// CrashKeys section: -// -// A maximum of 26 crash keys of each size can be specified for use by the -// application. Crash key values will be truncated based on the specified size -// (small = 64 bytes, medium = 256 bytes, large = 1024 bytes). The value of -// crash keys can be set from any thread or process using the -// CefSetCrashKeyValue function. These key/value pairs will be sent to the crash -// server along with the crash dump file. +/// Crash reporting is configured using an INI-style config file named +/// "crash_reporter.cfg". On Windows and Linux this file must be placed next to +/// the main application executable. On macOS this file must be placed in the +/// top-level app bundle Resources directory (e.g. +/// ".app/Contents/Resources"). File contents are as follows: +/// +/// 
+///  # Comments start with a hash character and must be on their own line.
+///
+///  [Config]
+///  ProductName=
+///  ProductVersion=
+///  AppName=
+///  ExternalHandler=
+///  BrowserCrashForwardingEnabled=
+///  ServerURL=
+///  RateLimitEnabled=
+///  MaxUploadsPerDay=
+///  MaxDatabaseSizeInMb=
+///  MaxDatabaseAgeInDays=
+///
+///  [CrashKeys]
+///  my_key1=
+///  my_key2=
+///
+/// +/// Config section: +/// +/// If "ProductName" and/or "ProductVersion" are set then the specified values +/// will be included in the crash dump metadata. On macOS if these values are +/// set to NULL then they will be retrieved from the Info.plist file using the +/// "CFBundleName" and "CFBundleShortVersionString" keys respectively. +/// +/// If "AppName" is set on Windows then crash report information (metrics, +/// database and dumps) will be stored locally on disk under the +/// "C:\Users\[CurrentUser]\AppData\Local\[AppName]\User Data" folder. On other +/// platforms the cef_settings_t.user_data_path value will be used. +/// +/// If "ExternalHandler" is set on Windows then the specified exe will be +/// launched as the crashpad-handler instead of re-launching the main process +/// exe. The value can be an absolute path or a path relative to the main exe +/// directory. On Linux the cef_settings_t.browser_subprocess_path value will be +/// used. On macOS the existing subprocess app bundle will be used. +/// +/// If "BrowserCrashForwardingEnabled" is set to true (1) on macOS then browser +/// process crashes will be forwarded to the system crash reporter. This results +/// in the crash UI dialog being displayed to the user and crash reports being +/// logged under "~/Library/Logs/DiagnosticReports". Forwarding of crash reports +/// from non-browser processes and Debug builds is always disabled. +/// +/// If "ServerURL" is set then crashes will be uploaded as a multi-part POST +/// request to the specified URL. Otherwise, reports will only be stored locally +/// on disk. +/// +/// If "RateLimitEnabled" is set to true (1) then crash report uploads will be +/// rate limited as follows: +/// 1. If "MaxUploadsPerDay" is set to a positive value then at most the +/// specified number of crashes will be uploaded in each 24 hour period. +/// 2. If crash upload fails due to a network or server error then an +/// incremental backoff delay up to a maximum of 24 hours will be applied +/// for retries. +/// 3. If a backoff delay is applied and "MaxUploadsPerDay" is > 1 then the +/// "MaxUploadsPerDay" value will be reduced to 1 until the client is +/// restarted. This helps to avoid an upload flood when the network or +/// server error is resolved. +/// Rate limiting is not supported on Linux. +/// +/// If "MaxDatabaseSizeInMb" is set to a positive value then crash report +/// storage on disk will be limited to that size in megabytes. For example, on +/// Windows each dump is about 600KB so a "MaxDatabaseSizeInMb" value of 20 +/// equates to about 34 crash reports stored on disk. Not supported on Linux. +/// +/// If "MaxDatabaseAgeInDays" is set to a positive value then crash reports +/// older than the specified age in days will be deleted. Not supported on +/// Linux. +/// +/// CrashKeys section: +/// +/// A maximum of 26 crash keys of each size can be specified for use by the +/// application. Crash key values will be truncated based on the specified size +/// (small = 64 bytes, medium = 256 bytes, large = 1024 bytes). The value of +/// crash keys can be set from any thread or process using the +/// CefSetCrashKeyValue function. These key/value pairs will be sent to the +/// crash server along with the crash dump file. /// CEF_EXPORT int cef_crash_reporting_enabled(void); /// -// Sets or clears a specific key-value pair from the crash metadata. +/// Sets or clears a specific key-value pair from the crash metadata. /// CEF_EXPORT void cef_set_crash_key_value(const cef_string_t* key, const cef_string_t* value); diff --git a/include/capi/cef_devtools_message_observer_capi.h b/include/capi/cef_devtools_message_observer_capi.h index 137f82136..ac64869eb 100644 --- a/include/capi/cef_devtools_message_observer_capi.h +++ b/include/capi/cef_devtools_message_observer_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=ec62239c2b24ff512b64ca758be825ff57fb3b6b$ +// $hash=076a01db2fc4241efeb46c5f247a9737fd828f9b$ // #ifndef CEF_INCLUDE_CAPI_CEF_DEVTOOLS_MESSAGE_OBSERVER_CAPI_H_ @@ -49,35 +49,36 @@ extern "C" { struct _cef_browser_t; /// -// Callback structure for cef_browser_host_t::AddDevToolsMessageObserver. The -// functions of this structure will be called on the browser process UI thread. +/// Callback structure for cef_browser_host_t::AddDevToolsMessageObserver. The +/// functions of this structure will be called on the browser process UI thread. /// typedef struct _cef_dev_tools_message_observer_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Method that will be called on receipt of a DevTools protocol message. - // |browser| is the originating browser instance. |message| is a UTF8-encoded - // JSON dictionary representing either a function result or an event. - // |message| is only valid for the scope of this callback and should be copied - // if necessary. Return true (1) if the message was handled or false (0) if - // the message should be further processed and passed to the - // OnDevToolsMethodResult or OnDevToolsEvent functions as appropriate. - // - // Method result dictionaries include an "id" (int) value that identifies the - // orginating function call sent from cef_browser_host_t::SendDevToolsMessage, - // and optionally either a "result" (dictionary) or "error" (dictionary) - // value. The "error" dictionary will contain "code" (int) and "message" - // (string) values. Event dictionaries include a "function" (string) value and - // optionally a "params" (dictionary) value. See the DevTools protocol - // documentation at https://chromedevtools.github.io/devtools-protocol/ for - // details of supported function calls and the expected "result" or "params" - // dictionary contents. JSON dictionaries can be parsed using the CefParseJSON - // function if desired, however be aware of performance considerations when - // parsing large messages (some of which may exceed 1MB in size). + /// Method that will be called on receipt of a DevTools protocol message. + /// |browser| is the originating browser instance. |message| is a UTF8-encoded + /// JSON dictionary representing either a function result or an event. + /// |message| is only valid for the scope of this callback and should be + /// copied if necessary. Return true (1) if the message was handled or false + /// (0) if the message should be further processed and passed to the + /// OnDevToolsMethodResult or OnDevToolsEvent functions as appropriate. + /// + /// Method result dictionaries include an "id" (int) value that identifies the + /// orginating function call sent from + /// cef_browser_host_t::SendDevToolsMessage, and optionally either a "result" + /// (dictionary) or "error" (dictionary) value. The "error" dictionary will + /// contain "code" (int) and "message" (string) values. Event dictionaries + /// include a "function" (string) value and optionally a "params" (dictionary) + /// value. See the DevTools protocol documentation at + /// https://chromedevtools.github.io/devtools-protocol/ for details of + /// supported function calls and the expected "result" or "params" dictionary + /// contents. JSON dictionaries can be parsed using the CefParseJSON function + /// if desired, however be aware of performance considerations when parsing + /// large messages (some of which may exceed 1MB in size). /// int(CEF_CALLBACK* on_dev_tools_message)( struct _cef_dev_tools_message_observer_t* self, @@ -86,16 +87,16 @@ typedef struct _cef_dev_tools_message_observer_t { size_t message_size); /// - // Method that will be called after attempted execution of a DevTools protocol - // function. |browser| is the originating browser instance. |message_id| is - // the "id" value that identifies the originating function call message. If - // the function succeeded |success| will be true (1) and |result| will be the - // UTF8-encoded JSON "result" dictionary value (which may be NULL). If the - // function failed |success| will be false (0) and |result| will be the - // UTF8-encoded JSON "error" dictionary value. |result| is only valid for the - // scope of this callback and should be copied if necessary. See the - // OnDevToolsMessage documentation for additional details on |result| - // contents. + /// Method that will be called after attempted execution of a DevTools + /// protocol function. |browser| is the originating browser instance. + /// |message_id| is the "id" value that identifies the originating function + /// call message. If the function succeeded |success| will be true (1) and + /// |result| will be the UTF8-encoded JSON "result" dictionary value (which + /// may be NULL). If the function failed |success| will be false (0) and + /// |result| will be the UTF8-encoded JSON "error" dictionary value. |result| + /// is only valid for the scope of this callback and should be copied if + /// necessary. See the OnDevToolsMessage documentation for additional details + /// on |result| contents. /// void(CEF_CALLBACK* on_dev_tools_method_result)( struct _cef_dev_tools_message_observer_t* self, @@ -106,12 +107,12 @@ typedef struct _cef_dev_tools_message_observer_t { size_t result_size); /// - // Method that will be called on receipt of a DevTools protocol event. - // |browser| is the originating browser instance. |function| is the "function" - // value. |params| is the UTF8-encoded JSON "params" dictionary value (which - // may be NULL). |params| is only valid for the scope of this callback and - // should be copied if necessary. See the OnDevToolsMessage documentation for - // additional details on |params| contents. + /// Method that will be called on receipt of a DevTools protocol event. + /// |browser| is the originating browser instance. |function| is the + /// "function" value. |params| is the UTF8-encoded JSON "params" dictionary + /// value (which may be NULL). |params| is only valid for the scope of this + /// callback and should be copied if necessary. See the OnDevToolsMessage + /// documentation for additional details on |params| contents. /// void(CEF_CALLBACK* on_dev_tools_event)( struct _cef_dev_tools_message_observer_t* self, @@ -121,19 +122,19 @@ typedef struct _cef_dev_tools_message_observer_t { size_t params_size); /// - // Method that will be called when the DevTools agent has attached. |browser| - // is the originating browser instance. This will generally occur in response - // to the first message sent while the agent is detached. + /// Method that will be called when the DevTools agent has attached. |browser| + /// is the originating browser instance. This will generally occur in response + /// to the first message sent while the agent is detached. /// void(CEF_CALLBACK* on_dev_tools_agent_attached)( struct _cef_dev_tools_message_observer_t* self, struct _cef_browser_t* browser); /// - // Method that will be called when the DevTools agent has detached. |browser| - // is the originating browser instance. Any function results that were pending - // before the agent became detached will not be delivered, and any active - // event subscriptions will be canceled. + /// Method that will be called when the DevTools agent has detached. |browser| + /// is the originating browser instance. Any function results that were + /// pending before the agent became detached will not be delivered, and any + /// active event subscriptions will be canceled. /// void(CEF_CALLBACK* on_dev_tools_agent_detached)( struct _cef_dev_tools_message_observer_t* self, diff --git a/include/capi/cef_dialog_handler_capi.h b/include/capi/cef_dialog_handler_capi.h index c28710ee1..ecf900c08 100644 --- a/include/capi/cef_dialog_handler_capi.h +++ b/include/capi/cef_dialog_handler_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=dc579beb1f25f9bbdb72afb4b5b381e129f84e31$ +// $hash=3a1a3ac84690c6090d356ddec3ddb49b934fe28c$ // #ifndef CEF_INCLUDE_CAPI_CEF_DIALOG_HANDLER_CAPI_H_ @@ -48,51 +48,51 @@ extern "C" { #endif /// -// Callback structure for asynchronous continuation of file dialog requests. +/// Callback structure for asynchronous continuation of file dialog requests. /// typedef struct _cef_file_dialog_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Continue the file selection. |file_paths| should be a single value or a - // list of values depending on the dialog mode. An NULL |file_paths| value is - // treated the same as calling cancel(). + /// Continue the file selection. |file_paths| should be a single value or a + /// list of values depending on the dialog mode. An NULL |file_paths| value is + /// treated the same as calling cancel(). /// void(CEF_CALLBACK* cont)(struct _cef_file_dialog_callback_t* self, cef_string_list_t file_paths); /// - // Cancel the file selection. + /// Cancel the file selection. /// void(CEF_CALLBACK* cancel)(struct _cef_file_dialog_callback_t* self); } cef_file_dialog_callback_t; /// -// Implement this structure to handle dialog events. The functions of this -// structure will be called on the browser process UI thread. +/// Implement this structure to handle dialog events. The functions of this +/// structure will be called on the browser process UI thread. /// typedef struct _cef_dialog_handler_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called to run a file chooser dialog. |mode| represents the type of dialog - // to display. |title| to the title to be used for the dialog and may be NULL - // to show the default title ("Open" or "Save" depending on the mode). - // |default_file_path| is the path with optional directory and/or file name - // component that should be initially selected in the dialog. |accept_filters| - // are used to restrict the selectable file types and may any combination of - // (a) valid lower-cased MIME types (e.g. "text/*" or "image/*"), (b) - // individual file extensions (e.g. ".txt" or ".png"), or (c) combined - // description and file extension delimited using "|" and ";" (e.g. "Image - // Types|.png;.gif;.jpg"). To display a custom dialog return true (1) and - // execute |callback| either inline or at a later time. To display the default - // dialog return false (0). + /// Called to run a file chooser dialog. |mode| represents the type of dialog + /// to display. |title| to the title to be used for the dialog and may be NULL + /// to show the default title ("Open" or "Save" depending on the mode). + /// |default_file_path| is the path with optional directory and/or file name + /// component that should be initially selected in the dialog. + /// |accept_filters| are used to restrict the selectable file types and may + /// any combination of (a) valid lower-cased MIME types (e.g. "text/*" or + /// "image/*"), (b) individual file extensions (e.g. ".txt" or ".png"), or (c) + /// combined description and file extension delimited using "|" and ";" (e.g. + /// "Image Types|.png;.gif;.jpg"). To display a custom dialog return true (1) + /// and execute |callback| either inline or at a later time. To display the + /// default dialog return false (0). /// int(CEF_CALLBACK* on_file_dialog)( struct _cef_dialog_handler_t* self, diff --git a/include/capi/cef_display_handler_capi.h b/include/capi/cef_display_handler_capi.h index 2b677d9fa..17fddfbab 100644 --- a/include/capi/cef_display_handler_capi.h +++ b/include/capi/cef_display_handler_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=adb78c1968bb0634d6255e1b5e49b56211da4fa8$ +// $hash=976a61df924efbcb0c53afeb75265e5e9e80c2de$ // #ifndef CEF_INCLUDE_CAPI_CEF_DISPLAY_HANDLER_CAPI_H_ @@ -49,17 +49,17 @@ extern "C" { #endif /// -// Implement this structure to handle events related to browser display state. -// The functions of this structure will be called on the UI thread. +/// Implement this structure to handle events related to browser display state. +/// The functions of this structure will be called on the UI thread. /// typedef struct _cef_display_handler_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called when a frame's address has changed. + /// Called when a frame's address has changed. /// void(CEF_CALLBACK* on_address_change)(struct _cef_display_handler_t* self, struct _cef_browser_t* browser, @@ -67,25 +67,25 @@ typedef struct _cef_display_handler_t { const cef_string_t* url); /// - // Called when the page title changes. + /// Called when the page title changes. /// void(CEF_CALLBACK* on_title_change)(struct _cef_display_handler_t* self, struct _cef_browser_t* browser, const cef_string_t* title); /// - // Called when the page icon changes. + /// Called when the page icon changes. /// void(CEF_CALLBACK* on_favicon_urlchange)(struct _cef_display_handler_t* self, struct _cef_browser_t* browser, cef_string_list_t icon_urls); /// - // Called when web content in the page has toggled fullscreen mode. If - // |fullscreen| is true (1) the content will automatically be sized to fill - // the browser content area. If |fullscreen| is false (0) the content will - // automatically return to its original size and position. The client is - // responsible for resizing the browser if desired. + /// Called when web content in the page has toggled fullscreen mode. If + /// |fullscreen| is true (1) the content will automatically be sized to fill + /// the browser content area. If |fullscreen| is false (0) the content will + /// automatically return to its original size and position. The client is + /// responsible for resizing the browser if desired. /// void(CEF_CALLBACK* on_fullscreen_mode_change)( struct _cef_display_handler_t* self, @@ -93,28 +93,28 @@ typedef struct _cef_display_handler_t { int fullscreen); /// - // Called when the browser is about to display a tooltip. |text| contains the - // text that will be displayed in the tooltip. To handle the display of the - // tooltip yourself return true (1). Otherwise, you can optionally modify - // |text| and then return false (0) to allow the browser to display the - // tooltip. When window rendering is disabled the application is responsible - // for drawing tooltips and the return value is ignored. + /// Called when the browser is about to display a tooltip. |text| contains the + /// text that will be displayed in the tooltip. To handle the display of the + /// tooltip yourself return true (1). Otherwise, you can optionally modify + /// |text| and then return false (0) to allow the browser to display the + /// tooltip. When window rendering is disabled the application is responsible + /// for drawing tooltips and the return value is ignored. /// int(CEF_CALLBACK* on_tooltip)(struct _cef_display_handler_t* self, struct _cef_browser_t* browser, cef_string_t* text); /// - // Called when the browser receives a status message. |value| contains the - // text that will be displayed in the status message. + /// Called when the browser receives a status message. |value| contains the + /// text that will be displayed in the status message. /// void(CEF_CALLBACK* on_status_message)(struct _cef_display_handler_t* self, struct _cef_browser_t* browser, const cef_string_t* value); /// - // Called to display a console message. Return true (1) to stop the message - // from being output to the console. + /// Called to display a console message. Return true (1) to stop the message + /// from being output to the console. /// int(CEF_CALLBACK* on_console_message)(struct _cef_display_handler_t* self, struct _cef_browser_t* browser, @@ -124,18 +124,18 @@ typedef struct _cef_display_handler_t { int line); /// - // Called when auto-resize is enabled via - // cef_browser_host_t::SetAutoResizeEnabled and the contents have auto- - // resized. |new_size| will be the desired size in view coordinates. Return - // true (1) if the resize was handled or false (0) for default handling. + /// Called when auto-resize is enabled via + /// cef_browser_host_t::SetAutoResizeEnabled and the contents have auto- + /// resized. |new_size| will be the desired size in view coordinates. Return + /// true (1) if the resize was handled or false (0) for default handling. /// int(CEF_CALLBACK* on_auto_resize)(struct _cef_display_handler_t* self, struct _cef_browser_t* browser, const cef_size_t* new_size); /// - // Called when the overall page loading progress has changed. |progress| - // ranges from 0.0 to 1.0. + /// Called when the overall page loading progress has changed. |progress| + /// ranges from 0.0 to 1.0. /// void(CEF_CALLBACK* on_loading_progress_change)( struct _cef_display_handler_t* self, @@ -143,10 +143,10 @@ typedef struct _cef_display_handler_t { double progress); /// - // Called when the browser's cursor has changed. If |type| is CT_CUSTOM then - // |custom_cursor_info| will be populated with the custom cursor information. - // Return true (1) if the cursor change was handled or false (0) for default - // handling. + /// Called when the browser's cursor has changed. If |type| is CT_CUSTOM then + /// |custom_cursor_info| will be populated with the custom cursor information. + /// Return true (1) if the cursor change was handled or false (0) for default + /// handling. /// int(CEF_CALLBACK* on_cursor_change)( struct _cef_display_handler_t* self, @@ -156,8 +156,8 @@ typedef struct _cef_display_handler_t { const cef_cursor_info_t* custom_cursor_info); /// - // Called when the browser's access to an audio and/or video source has - // changed. + /// Called when the browser's access to an audio and/or video source has + /// changed. /// void(CEF_CALLBACK* on_media_access_change)( struct _cef_display_handler_t* self, diff --git a/include/capi/cef_dom_capi.h b/include/capi/cef_dom_capi.h index 7e28e8992..2db400cfb 100644 --- a/include/capi/cef_dom_capi.h +++ b/include/capi/cef_dom_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=ddff4ad975fc26d0abfe05799aedb597b8274ffd$ +// $hash=47d8c186f687b65c8e7f394b97d72530e67593cd$ // #ifndef CEF_INCLUDE_CAPI_CEF_DOM_CAPI_H_ @@ -50,120 +50,120 @@ struct _cef_domdocument_t; struct _cef_domnode_t; /// -// Structure to implement for visiting the DOM. The functions of this structure -// will be called on the render process main thread. +/// Structure to implement for visiting the DOM. The functions of this structure +/// will be called on the render process main thread. /// typedef struct _cef_domvisitor_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Method executed for visiting the DOM. The document object passed to this - // function represents a snapshot of the DOM at the time this function is - // executed. DOM objects are only valid for the scope of this function. Do not - // keep references to or attempt to access any DOM objects outside the scope - // of this function. + /// Method executed for visiting the DOM. The document object passed to this + /// function represents a snapshot of the DOM at the time this function is + /// executed. DOM objects are only valid for the scope of this function. Do + /// not keep references to or attempt to access any DOM objects outside the + /// scope of this function. /// void(CEF_CALLBACK* visit)(struct _cef_domvisitor_t* self, struct _cef_domdocument_t* document); } cef_domvisitor_t; /// -// Structure used to represent a DOM document. The functions of this structure -// should only be called on the render process main thread thread. +/// Structure used to represent a DOM document. The functions of this structure +/// should only be called on the render process main thread thread. /// typedef struct _cef_domdocument_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Returns the document type. + /// Returns the document type. /// cef_dom_document_type_t(CEF_CALLBACK* get_type)( struct _cef_domdocument_t* self); /// - // Returns the root document node. + /// Returns the root document node. /// struct _cef_domnode_t*(CEF_CALLBACK* get_document)( struct _cef_domdocument_t* self); /// - // Returns the BODY node of an HTML document. + /// Returns the BODY node of an HTML document. /// struct _cef_domnode_t*(CEF_CALLBACK* get_body)( struct _cef_domdocument_t* self); /// - // Returns the HEAD node of an HTML document. + /// Returns the HEAD node of an HTML document. /// struct _cef_domnode_t*(CEF_CALLBACK* get_head)( struct _cef_domdocument_t* self); /// - // Returns the title of an HTML document. + /// Returns the title of an HTML document. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_title)( struct _cef_domdocument_t* self); /// - // Returns the document element with the specified ID value. + /// Returns the document element with the specified ID value. /// struct _cef_domnode_t*(CEF_CALLBACK* get_element_by_id)( struct _cef_domdocument_t* self, const cef_string_t* id); /// - // Returns the node that currently has keyboard focus. + /// Returns the node that currently has keyboard focus. /// struct _cef_domnode_t*(CEF_CALLBACK* get_focused_node)( struct _cef_domdocument_t* self); /// - // Returns true (1) if a portion of the document is selected. + /// Returns true (1) if a portion of the document is selected. /// int(CEF_CALLBACK* has_selection)(struct _cef_domdocument_t* self); /// - // Returns the selection offset within the start node. + /// Returns the selection offset within the start node. /// int(CEF_CALLBACK* get_selection_start_offset)( struct _cef_domdocument_t* self); /// - // Returns the selection offset within the end node. + /// Returns the selection offset within the end node. /// int(CEF_CALLBACK* get_selection_end_offset)(struct _cef_domdocument_t* self); /// - // Returns the contents of this selection as markup. + /// Returns the contents of this selection as markup. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_selection_as_markup)( struct _cef_domdocument_t* self); /// - // Returns the contents of this selection as text. + /// Returns the contents of this selection as text. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_selection_as_text)( struct _cef_domdocument_t* self); /// - // Returns the base URL for the document. + /// Returns the base URL for the document. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_base_url)( struct _cef_domdocument_t* self); /// - // Returns a complete URL based on the document base URL and the specified - // partial URL. + /// Returns a complete URL based on the document base URL and the specified + /// partial URL. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_complete_url)( @@ -172,141 +172,139 @@ typedef struct _cef_domdocument_t { } cef_domdocument_t; /// -// Structure used to represent a DOM node. The functions of this structure -// should only be called on the render process main thread. +/// Structure used to represent a DOM node. The functions of this structure +/// should only be called on the render process main thread. /// typedef struct _cef_domnode_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Returns the type for this node. + /// Returns the type for this node. /// cef_dom_node_type_t(CEF_CALLBACK* get_type)(struct _cef_domnode_t* self); /// - // Returns true (1) if this is a text node. + /// Returns true (1) if this is a text node. /// int(CEF_CALLBACK* is_text)(struct _cef_domnode_t* self); /// - // Returns true (1) if this is an element node. + /// Returns true (1) if this is an element node. /// int(CEF_CALLBACK* is_element)(struct _cef_domnode_t* self); /// - // Returns true (1) if this is an editable node. + /// Returns true (1) if this is an editable node. /// int(CEF_CALLBACK* is_editable)(struct _cef_domnode_t* self); /// - // Returns true (1) if this is a form control element node. + /// Returns true (1) if this is a form control element node. /// int(CEF_CALLBACK* is_form_control_element)(struct _cef_domnode_t* self); /// - // Returns the type of this form control element node. + /// Returns the type of this form control element node. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_form_control_element_type)( struct _cef_domnode_t* self); /// - // Returns true (1) if this object is pointing to the same handle as |that| - // object. + /// Returns true (1) if this object is pointing to the same handle as |that| + /// object. /// int(CEF_CALLBACK* is_same)(struct _cef_domnode_t* self, struct _cef_domnode_t* that); /// - // Returns the name of this node. + /// Returns the name of this node. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_name)(struct _cef_domnode_t* self); /// - // Returns the value of this node. + /// Returns the value of this node. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_value)(struct _cef_domnode_t* self); /// - // Set the value of this node. Returns true (1) on success. + /// Set the value of this node. Returns true (1) on success. /// int(CEF_CALLBACK* set_value)(struct _cef_domnode_t* self, const cef_string_t* value); /// - // Returns the contents of this node as markup. + /// Returns the contents of this node as markup. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_as_markup)( struct _cef_domnode_t* self); /// - // Returns the document associated with this node. + /// Returns the document associated with this node. /// struct _cef_domdocument_t*(CEF_CALLBACK* get_document)( struct _cef_domnode_t* self); /// - // Returns the parent node. + /// Returns the parent node. /// struct _cef_domnode_t*(CEF_CALLBACK* get_parent)(struct _cef_domnode_t* self); /// - // Returns the previous sibling node. + /// Returns the previous sibling node. /// struct _cef_domnode_t*(CEF_CALLBACK* get_previous_sibling)( struct _cef_domnode_t* self); /// - // Returns the next sibling node. + /// Returns the next sibling node. /// struct _cef_domnode_t*(CEF_CALLBACK* get_next_sibling)( struct _cef_domnode_t* self); /// - // Returns true (1) if this node has child nodes. + /// Returns true (1) if this node has child nodes. /// int(CEF_CALLBACK* has_children)(struct _cef_domnode_t* self); /// - // Return the first child node. + /// Return the first child node. /// struct _cef_domnode_t*(CEF_CALLBACK* get_first_child)( struct _cef_domnode_t* self); /// - // Returns the last child node. + /// Returns the last child node. /// struct _cef_domnode_t*(CEF_CALLBACK* get_last_child)( struct _cef_domnode_t* self); - // The following functions are valid only for element nodes. - /// - // Returns the tag name of this element. + /// Returns the tag name of this element. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_element_tag_name)( struct _cef_domnode_t* self); /// - // Returns true (1) if this element has attributes. + /// Returns true (1) if this element has attributes. /// int(CEF_CALLBACK* has_element_attributes)(struct _cef_domnode_t* self); /// - // Returns true (1) if this element has an attribute named |attrName|. + /// Returns true (1) if this element has an attribute named |attrName|. /// int(CEF_CALLBACK* has_element_attribute)(struct _cef_domnode_t* self, const cef_string_t* attrName); /// - // Returns the element attribute named |attrName|. + /// Returns the element attribute named |attrName|. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_element_attribute)( @@ -314,29 +312,29 @@ typedef struct _cef_domnode_t { const cef_string_t* attrName); /// - // Returns a map of all element attributes. + /// Returns a map of all element attributes. /// void(CEF_CALLBACK* get_element_attributes)(struct _cef_domnode_t* self, cef_string_map_t attrMap); /// - // Set the value for the element attribute named |attrName|. Returns true (1) - // on success. + /// Set the value for the element attribute named |attrName|. Returns true (1) + /// on success. /// int(CEF_CALLBACK* set_element_attribute)(struct _cef_domnode_t* self, const cef_string_t* attrName, const cef_string_t* value); /// - // Returns the inner text of the element. + /// Returns the inner text of the element. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_element_inner_text)( struct _cef_domnode_t* self); /// - // Returns the bounds of the element in device pixels. Use - // "window.devicePixelRatio" to convert to/from CSS pixels. + /// Returns the bounds of the element in device pixels. Use + /// "window.devicePixelRatio" to convert to/from CSS pixels. /// cef_rect_t(CEF_CALLBACK* get_element_bounds)(struct _cef_domnode_t* self); } cef_domnode_t; diff --git a/include/capi/cef_download_handler_capi.h b/include/capi/cef_download_handler_capi.h index aa690f0f0..37a770d25 100644 --- a/include/capi/cef_download_handler_capi.h +++ b/include/capi/cef_download_handler_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=33862915eb4156a70794a346a090154c468763e2$ +// $hash=aff139899b4b8b769fd0e506d8a46e434f924eee$ // #ifndef CEF_INCLUDE_CAPI_CEF_DOWNLOAD_HANDLER_CAPI_H_ @@ -49,19 +49,19 @@ extern "C" { #endif /// -// Callback structure used to asynchronously continue a download. +/// Callback structure used to asynchronously continue a download. /// typedef struct _cef_before_download_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Call to continue the download. Set |download_path| to the full file path - // for the download including the file name or leave blank to use the - // suggested name and the default temp directory. Set |show_dialog| to true - // (1) if you do wish to show the default "Save As" dialog. + /// Call to continue the download. Set |download_path| to the full file path + /// for the download including the file name or leave blank to use the + /// suggested name and the default temp directory. Set |show_dialog| to true + /// (1) if you do wish to show the default "Save As" dialog. /// void(CEF_CALLBACK* cont)(struct _cef_before_download_callback_t* self, const cef_string_t* download_path, @@ -69,46 +69,46 @@ typedef struct _cef_before_download_callback_t { } cef_before_download_callback_t; /// -// Callback structure used to asynchronously cancel a download. +/// Callback structure used to asynchronously cancel a download. /// typedef struct _cef_download_item_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Call to cancel the download. + /// Call to cancel the download. /// void(CEF_CALLBACK* cancel)(struct _cef_download_item_callback_t* self); /// - // Call to pause the download. + /// Call to pause the download. /// void(CEF_CALLBACK* pause)(struct _cef_download_item_callback_t* self); /// - // Call to resume the download. + /// Call to resume the download. /// void(CEF_CALLBACK* resume)(struct _cef_download_item_callback_t* self); } cef_download_item_callback_t; /// -// Structure used to handle file downloads. The functions of this structure will -// called on the browser process UI thread. +/// Structure used to handle file downloads. The functions of this structure +/// will called on the browser process UI thread. /// typedef struct _cef_download_handler_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called before a download begins in response to a user-initiated action - // (e.g. alt + link click or link click that returns a `Content-Disposition: - // attachment` response from the server). |url| is the target download URL and - // |request_function| is the target function (GET, POST, etc). Return true (1) - // to proceed with the download or false (0) to cancel the download. + /// Called before a download begins in response to a user-initiated action + /// (e.g. alt + link click or link click that returns a `Content-Disposition: + /// attachment` response from the server). |url| is the target download URL + /// and |request_function| is the target function (GET, POST, etc). Return + /// true (1) to proceed with the download or false (0) to cancel the download. /// int(CEF_CALLBACK* can_download)(struct _cef_download_handler_t* self, struct _cef_browser_t* browser, @@ -116,11 +116,11 @@ typedef struct _cef_download_handler_t { const cef_string_t* request_method); /// - // Called before a download begins. |suggested_name| is the suggested name for - // the download file. By default the download will be canceled. Execute - // |callback| either asynchronously or in this function to continue the - // download if desired. Do not keep a reference to |download_item| outside of - // this function. + /// Called before a download begins. |suggested_name| is the suggested name + /// for the download file. By default the download will be canceled. Execute + /// |callback| either asynchronously or in this function to continue the + /// download if desired. Do not keep a reference to |download_item| outside of + /// this function. /// void(CEF_CALLBACK* on_before_download)( struct _cef_download_handler_t* self, @@ -130,11 +130,11 @@ typedef struct _cef_download_handler_t { struct _cef_before_download_callback_t* callback); /// - // Called when a download's status or progress information has been updated. - // This may be called multiple times before and after on_before_download(). - // Execute |callback| either asynchronously or in this function to cancel the - // download if desired. Do not keep a reference to |download_item| outside of - // this function. + /// Called when a download's status or progress information has been updated. + /// This may be called multiple times before and after on_before_download(). + /// Execute |callback| either asynchronously or in this function to cancel the + /// download if desired. Do not keep a reference to |download_item| outside of + /// this function. /// void(CEF_CALLBACK* on_download_updated)( struct _cef_download_handler_t* self, diff --git a/include/capi/cef_download_item_capi.h b/include/capi/cef_download_item_capi.h index 38b8d96c2..5548c1a7a 100644 --- a/include/capi/cef_download_item_capi.h +++ b/include/capi/cef_download_item_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=1c1dd82539e356f15be95b66d824740075c48e4f$ +// $hash=a218058d7ceb842c9ea0cf0c252f9787de6562e7$ // #ifndef CEF_INCLUDE_CAPI_CEF_DOWNLOAD_ITEM_CAPI_H_ @@ -47,109 +47,109 @@ extern "C" { #endif /// -// Structure used to represent a download item. +/// Structure used to represent a download item. /// typedef struct _cef_download_item_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Returns true (1) if this object is valid. Do not call any other functions - // if this function returns false (0). + /// Returns true (1) if this object is valid. Do not call any other functions + /// if this function returns false (0). /// int(CEF_CALLBACK* is_valid)(struct _cef_download_item_t* self); /// - // Returns true (1) if the download is in progress. + /// Returns true (1) if the download is in progress. /// int(CEF_CALLBACK* is_in_progress)(struct _cef_download_item_t* self); /// - // Returns true (1) if the download is complete. + /// Returns true (1) if the download is complete. /// int(CEF_CALLBACK* is_complete)(struct _cef_download_item_t* self); /// - // Returns true (1) if the download has been canceled or interrupted. + /// Returns true (1) if the download has been canceled or interrupted. /// int(CEF_CALLBACK* is_canceled)(struct _cef_download_item_t* self); /// - // Returns a simple speed estimate in bytes/s. + /// Returns a simple speed estimate in bytes/s. /// int64(CEF_CALLBACK* get_current_speed)(struct _cef_download_item_t* self); /// - // Returns the rough percent complete or -1 if the receive total size is - // unknown. + /// Returns the rough percent complete or -1 if the receive total size is + /// unknown. /// int(CEF_CALLBACK* get_percent_complete)(struct _cef_download_item_t* self); /// - // Returns the total number of bytes. + /// Returns the total number of bytes. /// int64(CEF_CALLBACK* get_total_bytes)(struct _cef_download_item_t* self); /// - // Returns the number of received bytes. + /// Returns the number of received bytes. /// int64(CEF_CALLBACK* get_received_bytes)(struct _cef_download_item_t* self); /// - // Returns the time that the download started. + /// Returns the time that the download started. /// cef_basetime_t(CEF_CALLBACK* get_start_time)( struct _cef_download_item_t* self); /// - // Returns the time that the download ended. + /// Returns the time that the download ended. /// cef_basetime_t(CEF_CALLBACK* get_end_time)(struct _cef_download_item_t* self); /// - // Returns the full path to the downloaded or downloading file. + /// Returns the full path to the downloaded or downloading file. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_full_path)( struct _cef_download_item_t* self); /// - // Returns the unique identifier for this download. + /// Returns the unique identifier for this download. /// uint32(CEF_CALLBACK* get_id)(struct _cef_download_item_t* self); /// - // Returns the URL. + /// Returns the URL. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_url)( struct _cef_download_item_t* self); /// - // Returns the original URL before any redirections. + /// Returns the original URL before any redirections. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_original_url)( struct _cef_download_item_t* self); /// - // Returns the suggested file name. + /// Returns the suggested file name. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_suggested_file_name)( struct _cef_download_item_t* self); /// - // Returns the content disposition. + /// Returns the content disposition. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_content_disposition)( struct _cef_download_item_t* self); /// - // Returns the mime type. + /// Returns the mime type. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_mime_type)( diff --git a/include/capi/cef_drag_data_capi.h b/include/capi/cef_drag_data_capi.h index 656603afc..45a7c00c8 100644 --- a/include/capi/cef_drag_data_capi.h +++ b/include/capi/cef_drag_data_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=c99e9efb74fea2a2a99b25a694c59256f59238ab$ +// $hash=9e8375de3d30eb7e4f67488da3568d19848eb038$ // #ifndef CEF_INCLUDE_CAPI_CEF_DRAG_DATA_CAPI_H_ @@ -49,180 +49,180 @@ extern "C" { #endif /// -// Structure used to represent drag data. The functions of this structure may be -// called on any thread. +/// Structure used to represent drag data. The functions of this structure may +/// be called on any thread. /// typedef struct _cef_drag_data_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Returns a copy of the current object. + /// Returns a copy of the current object. /// struct _cef_drag_data_t*(CEF_CALLBACK* clone)(struct _cef_drag_data_t* self); /// - // Returns true (1) if this object is read-only. + /// Returns true (1) if this object is read-only. /// int(CEF_CALLBACK* is_read_only)(struct _cef_drag_data_t* self); /// - // Returns true (1) if the drag data is a link. + /// Returns true (1) if the drag data is a link. /// int(CEF_CALLBACK* is_link)(struct _cef_drag_data_t* self); /// - // Returns true (1) if the drag data is a text or html fragment. + /// Returns true (1) if the drag data is a text or html fragment. /// int(CEF_CALLBACK* is_fragment)(struct _cef_drag_data_t* self); /// - // Returns true (1) if the drag data is a file. + /// Returns true (1) if the drag data is a file. /// int(CEF_CALLBACK* is_file)(struct _cef_drag_data_t* self); /// - // Return the link URL that is being dragged. + /// Return the link URL that is being dragged. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_link_url)( struct _cef_drag_data_t* self); /// - // Return the title associated with the link being dragged. + /// Return the title associated with the link being dragged. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_link_title)( struct _cef_drag_data_t* self); /// - // Return the metadata, if any, associated with the link being dragged. + /// Return the metadata, if any, associated with the link being dragged. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_link_metadata)( struct _cef_drag_data_t* self); /// - // Return the plain text fragment that is being dragged. + /// Return the plain text fragment that is being dragged. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_fragment_text)( struct _cef_drag_data_t* self); /// - // Return the text/html fragment that is being dragged. + /// Return the text/html fragment that is being dragged. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_fragment_html)( struct _cef_drag_data_t* self); /// - // Return the base URL that the fragment came from. This value is used for - // resolving relative URLs and may be NULL. + /// Return the base URL that the fragment came from. This value is used for + /// resolving relative URLs and may be NULL. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_fragment_base_url)( struct _cef_drag_data_t* self); /// - // Return the name of the file being dragged out of the browser window. + /// Return the name of the file being dragged out of the browser window. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_file_name)( struct _cef_drag_data_t* self); /// - // Write the contents of the file being dragged out of the web view into - // |writer|. Returns the number of bytes sent to |writer|. If |writer| is NULL - // this function will return the size of the file contents in bytes. Call - // get_file_name() to get a suggested name for the file. + /// Write the contents of the file being dragged out of the web view into + /// |writer|. Returns the number of bytes sent to |writer|. If |writer| is + /// NULL this function will return the size of the file contents in bytes. + /// Call get_file_name() to get a suggested name for the file. /// size_t(CEF_CALLBACK* get_file_contents)(struct _cef_drag_data_t* self, struct _cef_stream_writer_t* writer); /// - // Retrieve the list of file names that are being dragged into the browser - // window. + /// Retrieve the list of file names that are being dragged into the browser + /// window. /// int(CEF_CALLBACK* get_file_names)(struct _cef_drag_data_t* self, cef_string_list_t names); /// - // Set the link URL that is being dragged. + /// Set the link URL that is being dragged. /// void(CEF_CALLBACK* set_link_url)(struct _cef_drag_data_t* self, const cef_string_t* url); /// - // Set the title associated with the link being dragged. + /// Set the title associated with the link being dragged. /// void(CEF_CALLBACK* set_link_title)(struct _cef_drag_data_t* self, const cef_string_t* title); /// - // Set the metadata associated with the link being dragged. + /// Set the metadata associated with the link being dragged. /// void(CEF_CALLBACK* set_link_metadata)(struct _cef_drag_data_t* self, const cef_string_t* data); /// - // Set the plain text fragment that is being dragged. + /// Set the plain text fragment that is being dragged. /// void(CEF_CALLBACK* set_fragment_text)(struct _cef_drag_data_t* self, const cef_string_t* text); /// - // Set the text/html fragment that is being dragged. + /// Set the text/html fragment that is being dragged. /// void(CEF_CALLBACK* set_fragment_html)(struct _cef_drag_data_t* self, const cef_string_t* html); /// - // Set the base URL that the fragment came from. + /// Set the base URL that the fragment came from. /// void(CEF_CALLBACK* set_fragment_base_url)(struct _cef_drag_data_t* self, const cef_string_t* base_url); /// - // Reset the file contents. You should do this before calling - // cef_browser_host_t::DragTargetDragEnter as the web view does not allow us - // to drag in this kind of data. + /// Reset the file contents. You should do this before calling + /// cef_browser_host_t::DragTargetDragEnter as the web view does not allow us + /// to drag in this kind of data. /// void(CEF_CALLBACK* reset_file_contents)(struct _cef_drag_data_t* self); /// - // Add a file that is being dragged into the webview. + /// Add a file that is being dragged into the webview. /// void(CEF_CALLBACK* add_file)(struct _cef_drag_data_t* self, const cef_string_t* path, const cef_string_t* display_name); /// - // Clear list of filenames. + /// Clear list of filenames. /// void(CEF_CALLBACK* clear_filenames)(struct _cef_drag_data_t* self); /// - // Get the image representation of drag data. May return NULL if no image - // representation is available. + /// Get the image representation of drag data. May return NULL if no image + /// representation is available. /// struct _cef_image_t*(CEF_CALLBACK* get_image)(struct _cef_drag_data_t* self); /// - // Get the image hotspot (drag start location relative to image dimensions). + /// Get the image hotspot (drag start location relative to image dimensions). /// cef_point_t(CEF_CALLBACK* get_image_hotspot)(struct _cef_drag_data_t* self); /// - // Returns true (1) if an image representation of drag data is available. + /// Returns true (1) if an image representation of drag data is available. /// int(CEF_CALLBACK* has_image)(struct _cef_drag_data_t* self); } cef_drag_data_t; /// -// Create a new cef_drag_data_t object. +/// Create a new cef_drag_data_t object. /// CEF_EXPORT cef_drag_data_t* cef_drag_data_create(void); diff --git a/include/capi/cef_drag_handler_capi.h b/include/capi/cef_drag_handler_capi.h index 68b26d716..a1c717b57 100644 --- a/include/capi/cef_drag_handler_capi.h +++ b/include/capi/cef_drag_handler_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=5b2051c42c1d4c41b85ca823d34b26bfa5de6777$ +// $hash=ec450acb2c3cc4d0e69b7da725387d5c1049773b$ // #ifndef CEF_INCLUDE_CAPI_CEF_DRAG_HANDLER_CAPI_H_ @@ -50,20 +50,20 @@ extern "C" { #endif /// -// Implement this structure to handle events related to dragging. The functions -// of this structure will be called on the UI thread. +/// Implement this structure to handle events related to dragging. The functions +/// of this structure will be called on the UI thread. /// typedef struct _cef_drag_handler_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called when an external drag event enters the browser window. |dragData| - // contains the drag event data and |mask| represents the type of drag - // operation. Return false (0) for default drag handling behavior or true (1) - // to cancel the drag event. + /// Called when an external drag event enters the browser window. |dragData| + /// contains the drag event data and |mask| represents the type of drag + /// operation. Return false (0) for default drag handling behavior or true (1) + /// to cancel the drag event. /// int(CEF_CALLBACK* on_drag_enter)(struct _cef_drag_handler_t* self, struct _cef_browser_t* browser, @@ -71,11 +71,11 @@ typedef struct _cef_drag_handler_t { cef_drag_operations_mask_t mask); /// - // Called whenever draggable regions for the browser window change. These can - // be specified using the '-webkit-app-region: drag/no-drag' CSS-property. If - // draggable regions are never defined in a document this function will also - // never be called. If the last draggable region is removed from a document - // this function will be called with an NULL vector. + /// Called whenever draggable regions for the browser window change. These can + /// be specified using the '-webkit-app-region: drag/no-drag' CSS-property. If + /// draggable regions are never defined in a document this function will also + /// never be called. If the last draggable region is removed from a document + /// this function will be called with an NULL vector. /// void(CEF_CALLBACK* on_draggable_regions_changed)( struct _cef_drag_handler_t* self, diff --git a/include/capi/cef_extension_capi.h b/include/capi/cef_extension_capi.h index 24ba87d64..008ad4a1f 100644 --- a/include/capi/cef_extension_capi.h +++ b/include/capi/cef_extension_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=fcfe34c1517ebdb3f00c1f737b91361e771b820d$ +// $hash=b16b1c47d26e911d360159e5535743622a411c31$ // #ifndef CEF_INCLUDE_CAPI_CEF_EXTENSION_CAPI_H_ @@ -51,74 +51,74 @@ struct _cef_extension_handler_t; struct _cef_request_context_t; /// -// Object representing an extension. Methods may be called on any thread unless -// otherwise indicated. +/// Object representing an extension. Methods may be called on any thread unless +/// otherwise indicated. /// typedef struct _cef_extension_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Returns the unique extension identifier. This is calculated based on the - // extension public key, if available, or on the extension path. See - // https://developer.chrome.com/extensions/manifest/key for details. + /// Returns the unique extension identifier. This is calculated based on the + /// extension public key, if available, or on the extension path. See + /// https://developer.chrome.com/extensions/manifest/key for details. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_identifier)( struct _cef_extension_t* self); /// - // Returns the absolute path to the extension directory on disk. This value - // will be prefixed with PK_DIR_RESOURCES if a relative path was passed to - // cef_request_context_t::LoadExtension. + /// Returns the absolute path to the extension directory on disk. This value + /// will be prefixed with PK_DIR_RESOURCES if a relative path was passed to + /// cef_request_context_t::LoadExtension. /// // The resulting string must be freed by calling cef_string_userfree_free(). cef_string_userfree_t(CEF_CALLBACK* get_path)(struct _cef_extension_t* self); /// - // Returns the extension manifest contents as a cef_dictionary_value_t object. - // See https://developer.chrome.com/extensions/manifest for details. + /// Returns the extension manifest contents as a cef_dictionary_value_t + /// object. See https://developer.chrome.com/extensions/manifest for details. /// struct _cef_dictionary_value_t*(CEF_CALLBACK* get_manifest)( struct _cef_extension_t* self); /// - // Returns true (1) if this object is the same extension as |that| object. - // Extensions are considered the same if identifier, path and loader context - // match. + /// Returns true (1) if this object is the same extension as |that| object. + /// Extensions are considered the same if identifier, path and loader context + /// match. /// int(CEF_CALLBACK* is_same)(struct _cef_extension_t* self, struct _cef_extension_t* that); /// - // Returns the handler for this extension. Will return NULL for internal - // extensions or if no handler was passed to - // cef_request_context_t::LoadExtension. + /// Returns the handler for this extension. Will return NULL for internal + /// extensions or if no handler was passed to + /// cef_request_context_t::LoadExtension. /// struct _cef_extension_handler_t*(CEF_CALLBACK* get_handler)( struct _cef_extension_t* self); /// - // Returns the request context that loaded this extension. Will return NULL - // for internal extensions or if the extension has been unloaded. See the - // cef_request_context_t::LoadExtension documentation for more information - // about loader contexts. Must be called on the browser process UI thread. + /// Returns the request context that loaded this extension. Will return NULL + /// for internal extensions or if the extension has been unloaded. See the + /// cef_request_context_t::LoadExtension documentation for more information + /// about loader contexts. Must be called on the browser process UI thread. /// struct _cef_request_context_t*(CEF_CALLBACK* get_loader_context)( struct _cef_extension_t* self); /// - // Returns true (1) if this extension is currently loaded. Must be called on - // the browser process UI thread. + /// Returns true (1) if this extension is currently loaded. Must be called on + /// the browser process UI thread. /// int(CEF_CALLBACK* is_loaded)(struct _cef_extension_t* self); /// - // Unload this extension if it is not an internal extension and is currently - // loaded. Will result in a call to - // cef_extension_handler_t::OnExtensionUnloaded on success. + /// Unload this extension if it is not an internal extension and is currently + /// loaded. Will result in a call to + /// cef_extension_handler_t::OnExtensionUnloaded on success. /// void(CEF_CALLBACK* unload)(struct _cef_extension_t* self); } cef_extension_t; diff --git a/include/capi/cef_extension_handler_capi.h b/include/capi/cef_extension_handler_capi.h index 73c4f3bca..3e0563b2e 100644 --- a/include/capi/cef_extension_handler_capi.h +++ b/include/capi/cef_extension_handler_capi.h @@ -33,7 +33,7 @@ // by hand. See the translator.README.txt file in the tools directory for // more information. // -// $hash=768e2436e54cceb2675ddd03ebdc61b5c0785bdc$ +// $hash=ba961ade334c82e53213e7e8ac848adc2a7b533a$ // #ifndef CEF_INCLUDE_CAPI_CEF_EXTENSION_HANDLER_CAPI_H_ @@ -52,75 +52,76 @@ extern "C" { struct _cef_client_t; /// -// Callback structure used for asynchronous continuation of -// cef_extension_handler_t::GetExtensionResource. +/// Callback structure used for asynchronous continuation of +/// cef_extension_handler_t::GetExtensionResource. /// typedef struct _cef_get_extension_resource_callback_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Continue the request. Read the resource contents from |stream|. + /// Continue the request. Read the resource contents from |stream|. /// void(CEF_CALLBACK* cont)(struct _cef_get_extension_resource_callback_t* self, struct _cef_stream_reader_t* stream); /// - // Cancel the request. + /// Cancel the request. /// void(CEF_CALLBACK* cancel)( struct _cef_get_extension_resource_callback_t* self); } cef_get_extension_resource_callback_t; /// -// Implement this structure to handle events related to browser extensions. The -// functions of this structure will be called on the UI thread. See -// cef_request_context_t::LoadExtension for information about extension loading. +/// Implement this structure to handle events related to browser extensions. The +/// functions of this structure will be called on the UI thread. See +/// cef_request_context_t::LoadExtension for information about extension +/// loading. /// typedef struct _cef_extension_handler_t { /// - // Base structure. + /// Base structure. /// cef_base_ref_counted_t base; /// - // Called if the cef_request_context_t::LoadExtension request fails. |result| - // will be the error code. + /// Called if the cef_request_context_t::LoadExtension request fails. |result| + /// will be the error code. /// void(CEF_CALLBACK* on_extension_load_failed)( struct _cef_extension_handler_t* self, cef_errorcode_t result); /// - // Called if the cef_request_context_t::LoadExtension request succeeds. - // |extension| is the loaded extension. + /// Called if the cef_request_context_t::LoadExtension request succeeds. + /// |extension| is the loaded extension. /// void(CEF_CALLBACK* on_extension_loaded)(struct _cef_extension_handler_t* self, struct _cef_extension_t* extension); /// - // Called after the cef_extension_t::Unload request has completed. + /// Called after the cef_extension_t::Unload request has completed. /// void(CEF_CALLBACK* on_extension_unloaded)( struct _cef_extension_handler_t* self, struct _cef_extension_t* extension); /// - // Called when an extension needs a browser to host a background script - // specified via the "background" manifest key. The browser will have no - // visible window and cannot be displayed. |extension| is the extension that - // is loading the background script. |url| is an internally generated - // reference to an HTML page that will be used to load the background script - // via a