bcarrella
/
cef
mirror of https://bitbucket.org/chromiumembedded/cef
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix documentation errors (issue #1834)

This commit is contained in:
Marshall Greenblatt 2016-03-01 17:17:08 -05:00
parent 1b8f76dd69
commit 1b7c5303ce
16 changed files with 111 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
include/capi/cef_browser_capi.h
View File

@ -174,7 +174,7 @@ typedef struct _cef_browser_t {
void (CEF_CALLBACK *get_frame_names)(struct _cef_browser_t* self, void (CEF_CALLBACK *get_frame_names)(struct _cef_browser_t* self,
cef_string_list_t names); cef_string_list_t names);
// ///
// Send a message to the specified |target_process|. Returns true (1) if the // Send a message to the specified |target_process|. Returns true (1) if the
// message was sent successfully. // message was sent successfully.
/// ///
@ -418,7 +418,6 @@ typedef struct _cef_browser_host_t {
// navigation entry will be sent, otherwise all navigation entries will be // navigation entry will be sent, otherwise all navigation entries will be
// sent. // sent.
/// ///
///
void (CEF_CALLBACK *get_navigation_entries)(struct _cef_browser_host_t* self, void (CEF_CALLBACK *get_navigation_entries)(struct _cef_browser_host_t* self,
struct _cef_navigation_entry_visitor_t* visitor, int current_only); struct _cef_navigation_entry_visitor_t* visitor, int current_only);

2
include/capi/cef_keyboard_handler_capi.h
View File

@ -56,11 +56,13 @@ typedef struct _cef_keyboard_handler_t {
/// ///
cef_base_t base; cef_base_t base;
///
// Called before a keyboard event is sent to the renderer. |event| contains // Called before a keyboard event is sent to the renderer. |event| contains
// information about the keyboard event. |os_event| is the operating system // information about the keyboard event. |os_event| is the operating system
// event message, if any. Return true (1) if the event was handled or false // event message, if any. Return true (1) if the event was handled or false
// (0) otherwise. If the event will be handled in on_key_event() as a keyboard // (0) otherwise. If the event will be handled in on_key_event() as a keyboard
// shortcut set |is_keyboard_shortcut| to true (1) and return false (0). // shortcut set |is_keyboard_shortcut| to true (1) and return false (0).
///
int (CEF_CALLBACK *on_pre_key_event)(struct _cef_keyboard_handler_t* self, int (CEF_CALLBACK *on_pre_key_event)(struct _cef_keyboard_handler_t* self,
struct _cef_browser_t* browser, const struct _cef_key_event_t* event, struct _cef_browser_t* browser, const struct _cef_key_event_t* event,
cef_event_handle_t os_event, int* is_keyboard_shortcut); cef_event_handle_t os_event, int* is_keyboard_shortcut);

1
include/capi/cef_life_span_handler_capi.h
View File

@ -75,6 +75,7 @@ typedef struct _cef_life_span_handler_t {
// default to the source browser's values. If the |no_javascript_access| value // default to the source browser's values. If the |no_javascript_access| value
// is set to false (0) the new browser will not be scriptable and may not be // is set to false (0) the new browser will not be scriptable and may not be
// hosted in the same renderer process as the source browser. // hosted in the same renderer process as the source browser.
///
int (CEF_CALLBACK *on_before_popup)(struct _cef_life_span_handler_t* self, int (CEF_CALLBACK *on_before_popup)(struct _cef_life_span_handler_t* self,
struct _cef_browser_t* browser, struct _cef_frame_t* frame, struct _cef_browser_t* browser, struct _cef_frame_t* frame,
const cef_string_t* target_url, const cef_string_t* target_frame_name, const cef_string_t* target_url, const cef_string_t* target_frame_name,

60
include/capi/cef_menu_model_capi.h
View File

@ -67,59 +67,59 @@ typedef struct _cef_menu_model_t {
/// ///
int (CEF_CALLBACK *get_count)(struct _cef_menu_model_t* self); int (CEF_CALLBACK *get_count)(struct _cef_menu_model_t* self);
// ///
// Add a separator to the menu. Returns true (1) on success. // Add a separator to the menu. Returns true (1) on success.
/// ///
int (CEF_CALLBACK *add_separator)(struct _cef_menu_model_t* self); int (CEF_CALLBACK *add_separator)(struct _cef_menu_model_t* self);
// ///
// Add an item to the menu. Returns true (1) on success. // Add an item to the menu. Returns true (1) on success.
/// ///
int (CEF_CALLBACK *add_item)(struct _cef_menu_model_t* self, int command_id, int (CEF_CALLBACK *add_item)(struct _cef_menu_model_t* self, int command_id,
const cef_string_t* label); const cef_string_t* label);
// ///
// Add a check item to the menu. Returns true (1) on success. // Add a check item to the menu. Returns true (1) on success.
/// ///
int (CEF_CALLBACK *add_check_item)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *add_check_item)(struct _cef_menu_model_t* self,
int command_id, const cef_string_t* label); int command_id, const cef_string_t* label);
// ///
// Add a radio item to the menu. Only a single item with the specified // Add a radio item to the menu. Only a single item with the specified
// |group_id| can be checked at a time. Returns true (1) on success. // |group_id| can be checked at a time. Returns true (1) on success.
/// ///
int (CEF_CALLBACK *add_radio_item)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *add_radio_item)(struct _cef_menu_model_t* self,
int command_id, const cef_string_t* label, int group_id); int command_id, const cef_string_t* label, int group_id);
// ///
// Add a sub-menu to the menu. The new sub-menu is returned. // Add a sub-menu to the menu. The new sub-menu is returned.
/// ///
struct _cef_menu_model_t* (CEF_CALLBACK *add_sub_menu)( struct _cef_menu_model_t* (CEF_CALLBACK *add_sub_menu)(
struct _cef_menu_model_t* self, int command_id, struct _cef_menu_model_t* self, int command_id,
const cef_string_t* label); const cef_string_t* label);
// ///
// Insert a separator in the menu at the specified |index|. Returns true (1) // Insert a separator in the menu at the specified |index|. Returns true (1)
// on success. // on success.
/// ///
int (CEF_CALLBACK *insert_separator_at)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *insert_separator_at)(struct _cef_menu_model_t* self,
int index); int index);
// ///
// Insert an item in the menu at the specified |index|. Returns true (1) on // Insert an item in the menu at the specified |index|. Returns true (1) on
// success. // success.
/// ///
int (CEF_CALLBACK *insert_item_at)(struct _cef_menu_model_t* self, int index, int (CEF_CALLBACK *insert_item_at)(struct _cef_menu_model_t* self, int index,
int command_id, const cef_string_t* label); int command_id, const cef_string_t* label);
// ///
// Insert a check item in the menu at the specified |index|. Returns true (1) // Insert a check item in the menu at the specified |index|. Returns true (1)
// on success. // on success.
/// ///
int (CEF_CALLBACK *insert_check_item_at)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *insert_check_item_at)(struct _cef_menu_model_t* self,
int index, int command_id, const cef_string_t* label); int index, int command_id, const cef_string_t* label);
// ///
// Insert a radio item in the menu at the specified |index|. Only a single // Insert a radio item in the menu at the specified |index|. Only a single
// item with the specified |group_id| can be checked at a time. Returns true // item with the specified |group_id| can be checked at a time. Returns true
// (1) on success. // (1) on success.
@ -127,7 +127,7 @@ typedef struct _cef_menu_model_t {
int (CEF_CALLBACK *insert_radio_item_at)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *insert_radio_item_at)(struct _cef_menu_model_t* self,
int index, int command_id, const cef_string_t* label, int group_id); int index, int command_id, const cef_string_t* label, int group_id);
// ///
// Insert a sub-menu in the menu at the specified |index|. The new sub-menu is // Insert a sub-menu in the menu at the specified |index|. The new sub-menu is
// returned. // returned.
/// ///
@ -242,98 +242,98 @@ typedef struct _cef_menu_model_t {
struct _cef_menu_model_t* (CEF_CALLBACK *get_sub_menu_at)( struct _cef_menu_model_t* (CEF_CALLBACK *get_sub_menu_at)(
struct _cef_menu_model_t* self, int index); struct _cef_menu_model_t* self, int index);
// ///
// Returns true (1) if the specified |command_id| is visible. // Returns true (1) if the specified |command_id| is visible.
/// ///
int (CEF_CALLBACK *is_visible)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *is_visible)(struct _cef_menu_model_t* self,
int command_id); int command_id);
// ///
// Returns true (1) if the specified |index| is visible. // Returns true (1) if the specified |index| is visible.
/// ///
int (CEF_CALLBACK *is_visible_at)(struct _cef_menu_model_t* self, int index); int (CEF_CALLBACK *is_visible_at)(struct _cef_menu_model_t* self, int index);
// ///
// Change the visibility of the specified |command_id|. Returns true (1) on // Change the visibility of the specified |command_id|. Returns true (1) on
// success. // success.
/// ///
int (CEF_CALLBACK *set_visible)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *set_visible)(struct _cef_menu_model_t* self,
int command_id, int visible); int command_id, int visible);
// ///
// Change the visibility at the specified |index|. Returns true (1) on // Change the visibility at the specified |index|. Returns true (1) on
// success. // success.
/// ///
int (CEF_CALLBACK *set_visible_at)(struct _cef_menu_model_t* self, int index, int (CEF_CALLBACK *set_visible_at)(struct _cef_menu_model_t* self, int index,
int visible); int visible);
// ///
// Returns true (1) if the specified |command_id| is enabled. // Returns true (1) if the specified |command_id| is enabled.
/// ///
int (CEF_CALLBACK *is_enabled)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *is_enabled)(struct _cef_menu_model_t* self,
int command_id); int command_id);
// ///
// Returns true (1) if the specified |index| is enabled. // Returns true (1) if the specified |index| is enabled.
/// ///
int (CEF_CALLBACK *is_enabled_at)(struct _cef_menu_model_t* self, int index); int (CEF_CALLBACK *is_enabled_at)(struct _cef_menu_model_t* self, int index);
// ///
// Change the enabled status of the specified |command_id|. Returns true (1) // Change the enabled status of the specified |command_id|. Returns true (1)
// on success. // on success.
/// ///
int (CEF_CALLBACK *set_enabled)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *set_enabled)(struct _cef_menu_model_t* self,
int command_id, int enabled); int command_id, int enabled);
// ///
// Change the enabled status at the specified |index|. Returns true (1) on // Change the enabled status at the specified |index|. Returns true (1) on
// success. // success.
/// ///
int (CEF_CALLBACK *set_enabled_at)(struct _cef_menu_model_t* self, int index, int (CEF_CALLBACK *set_enabled_at)(struct _cef_menu_model_t* self, int index,
int enabled); int enabled);
// ///
// Returns true (1) if the specified |command_id| is checked. Only applies to // Returns true (1) if the specified |command_id| is checked. Only applies to
// check and radio items. // check and radio items.
/// ///
int (CEF_CALLBACK *is_checked)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *is_checked)(struct _cef_menu_model_t* self,
int command_id); int command_id);
// ///
// Returns true (1) if the specified |index| is checked. Only applies to check // Returns true (1) if the specified |index| is checked. Only applies to check
// and radio items. // and radio items.
/// ///
int (CEF_CALLBACK *is_checked_at)(struct _cef_menu_model_t* self, int index); int (CEF_CALLBACK *is_checked_at)(struct _cef_menu_model_t* self, int index);
// ///
// Check the specified |command_id|. Only applies to check and radio items. // Check the specified |command_id|. Only applies to check and radio items.
// Returns true (1) on success. // Returns true (1) on success.
/// ///
int (CEF_CALLBACK *set_checked)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *set_checked)(struct _cef_menu_model_t* self,
int command_id, int checked); int command_id, int checked);
// ///
// Check the specified |index|. Only applies to check and radio items. Returns // Check the specified |index|. Only applies to check and radio items. Returns
// true (1) on success. // true (1) on success.
/// ///
int (CEF_CALLBACK *set_checked_at)(struct _cef_menu_model_t* self, int index, int (CEF_CALLBACK *set_checked_at)(struct _cef_menu_model_t* self, int index,
int checked); int checked);
// ///
// Returns true (1) if the specified |command_id| has a keyboard accelerator // Returns true (1) if the specified |command_id| has a keyboard accelerator
// assigned. // assigned.
/// ///
int (CEF_CALLBACK *has_accelerator)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *has_accelerator)(struct _cef_menu_model_t* self,
int command_id); int command_id);
// ///
// Returns true (1) if the specified |index| has a keyboard accelerator // Returns true (1) if the specified |index| has a keyboard accelerator
// assigned. // assigned.
/// ///
int (CEF_CALLBACK *has_accelerator_at)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *has_accelerator_at)(struct _cef_menu_model_t* self,
int index); int index);
// ///
// Set the keyboard accelerator for the specified |command_id|. |key_code| can // Set the keyboard accelerator for the specified |command_id|. |key_code| can
// be any virtual key or character value. Returns true (1) on success. // be any virtual key or character value. Returns true (1) on success.
/// ///
@ -341,7 +341,7 @@ typedef struct _cef_menu_model_t {
int command_id, int key_code, int shift_pressed, int ctrl_pressed, int command_id, int key_code, int shift_pressed, int ctrl_pressed,
int alt_pressed); int alt_pressed);
// ///
// Set the keyboard accelerator at the specified |index|. |key_code| can be // Set the keyboard accelerator at the specified |index|. |key_code| can be
// any virtual key or character value. Returns true (1) on success. // any virtual key or character value. Returns true (1) on success.
/// ///
@ -349,21 +349,21 @@ typedef struct _cef_menu_model_t {
int index, int key_code, int shift_pressed, int ctrl_pressed, int index, int key_code, int shift_pressed, int ctrl_pressed,
int alt_pressed); int alt_pressed);
// ///
// Remove the keyboard accelerator for the specified |command_id|. Returns // Remove the keyboard accelerator for the specified |command_id|. Returns
// true (1) on success. // true (1) on success.
/// ///
int (CEF_CALLBACK *remove_accelerator)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *remove_accelerator)(struct _cef_menu_model_t* self,
int command_id); int command_id);
// ///
// Remove the keyboard accelerator at the specified |index|. Returns true (1) // Remove the keyboard accelerator at the specified |index|. Returns true (1)
// on success. // on success.
/// ///
int (CEF_CALLBACK *remove_accelerator_at)(struct _cef_menu_model_t* self, int (CEF_CALLBACK *remove_accelerator_at)(struct _cef_menu_model_t* self,
int index); int index);
// ///
// Retrieves the keyboard accelerator for the specified |command_id|. Returns // Retrieves the keyboard accelerator for the specified |command_id|. Returns
// true (1) on success. // true (1) on success.
/// ///
@ -371,7 +371,7 @@ typedef struct _cef_menu_model_t {
int command_id, int* key_code, int* shift_pressed, int* ctrl_pressed, int command_id, int* key_code, int* shift_pressed, int* ctrl_pressed,
int* alt_pressed); int* alt_pressed);
// ///
// Retrieves the keyboard accelerator for the specified |index|. Returns true // Retrieves the keyboard accelerator for the specified |index|. Returns true
// (1) on success. // (1) on success.
/// ///

8
include/capi/cef_parser_capi.h
View File

@ -82,10 +82,12 @@ CEF_EXPORT cef_string_userfree_t cef_format_url_for_security_display(
CEF_EXPORT cef_string_userfree_t cef_get_mime_type( CEF_EXPORT cef_string_userfree_t cef_get_mime_type(
const cef_string_t* extension); const cef_string_t* extension);
///
// Get the extensions associated with the given mime type. This should be passed // Get the extensions associated with the given mime type. This should be passed
// in lower case. There could be multiple extensions for a given mime type, like // in lower case. There could be multiple extensions for a given mime type, like
// "html,htm" for "text/html", or "txt,text,html,..." for "text/*". Any existing // "html,htm" for "text/html", or "txt,text,html,..." for "text/*". Any existing
// elements in the provided vector will not be erased. // elements in the provided vector will not be erased.
///
CEF_EXPORT void cef_get_extensions_for_mime_type(const cef_string_t* mime_type, CEF_EXPORT void cef_get_extensions_for_mime_type(const cef_string_t* mime_type,
cef_string_list_t extensions); cef_string_list_t extensions);
@ -127,22 +129,28 @@ CEF_EXPORT cef_string_userfree_t cef_uriencode(const cef_string_t* text,
CEF_EXPORT cef_string_userfree_t cef_uridecode(const cef_string_t* text, CEF_EXPORT cef_string_userfree_t cef_uridecode(const cef_string_t* text,
int convert_to_utf8, cef_uri_unescape_rule_t unescape_rule); int convert_to_utf8, cef_uri_unescape_rule_t unescape_rule);
///
// Parses the specified |json_string| and returns a dictionary or list // Parses the specified |json_string| and returns a dictionary or list
// representation. If JSON parsing fails this function returns NULL. // representation. If JSON parsing fails this function returns NULL.
///
CEF_EXPORT struct _cef_value_t* cef_parse_json(const cef_string_t* json_string, CEF_EXPORT struct _cef_value_t* cef_parse_json(const cef_string_t* json_string,
cef_json_parser_options_t options); cef_json_parser_options_t options);
///
// Parses the specified |json_string| and returns a dictionary or list // Parses the specified |json_string| and returns a dictionary or list
// representation. If JSON parsing fails this function returns NULL and // representation. If JSON parsing fails this function returns NULL and
// populates |error_code_out| and |error_msg_out| with an error code and a // populates |error_code_out| and |error_msg_out| with an error code and a
// formatted error message respectively. // formatted error message respectively.
///
CEF_EXPORT struct _cef_value_t* cef_parse_jsonand_return_error( CEF_EXPORT struct _cef_value_t* cef_parse_jsonand_return_error(
const cef_string_t* json_string, cef_json_parser_options_t options, const cef_string_t* json_string, cef_json_parser_options_t options,
cef_json_parser_error_t* error_code_out, cef_string_t* error_msg_out); cef_json_parser_error_t* error_code_out, cef_string_t* error_msg_out);
///
// Generates a JSON string from the specified root |node| which should be a // Generates a JSON string from the specified root |node| which should be a
// dictionary or list value. Returns an NULL string on failure. This function // dictionary or list value. Returns an NULL string on failure. This function
// requires exclusive access to |node| including any underlying data. // requires exclusive access to |node| including any underlying data.
///
// The resulting string must be freed by calling cef_string_userfree_free(). // The resulting string must be freed by calling cef_string_userfree_free().
CEF_EXPORT cef_string_userfree_t cef_write_json(struct _cef_value_t* node, CEF_EXPORT cef_string_userfree_t cef_write_json(struct _cef_value_t* node,
cef_json_writer_options_t options); cef_json_writer_options_t options);

2
include/capi/cef_response_filter_capi.h
View File

@ -61,6 +61,7 @@ typedef struct _cef_response_filter_t {
/// ///
int (CEF_CALLBACK *init_filter)(struct _cef_response_filter_t* self); int (CEF_CALLBACK *init_filter)(struct _cef_response_filter_t* self);
///
// Called to filter a chunk of data. |data_in| is the input buffer containing // Called to filter a chunk of data. |data_in| is the input buffer containing
// |data_in_size| bytes of pre-filter data (|data_in| will be NULL if // |data_in_size| bytes of pre-filter data (|data_in| will be NULL if
// |data_in_size| is zero). |data_out| is the output buffer that can accept up // |data_in_size| is zero). |data_out| is the output buffer that can accept up
@ -77,6 +78,7 @@ typedef struct _cef_response_filter_t {
// matches |data_in_size| (all available pre-filter bytes have been read), and // matches |data_in_size| (all available pre-filter bytes have been read), and
// the function returns RESPONSE_FILTER_DONE or RESPONSE_FILTER_ERROR. Do not // the function returns RESPONSE_FILTER_DONE or RESPONSE_FILTER_ERROR. Do not
// keep a reference to the buffers passed to this function. // keep a reference to the buffers passed to this function.
///
cef_response_filter_status_t (CEF_CALLBACK *filter)( cef_response_filter_status_t (CEF_CALLBACK *filter)(
struct _cef_response_filter_t* self, void* data_in, size_t data_in_size, struct _cef_response_filter_t* self, void* data_in, size_t data_in_size,
size_t* data_in_read, void* data_out, size_t data_out_size, size_t* data_in_read, void* data_out, size_t data_out_size,

3
include/cef_browser.h
View File

@ -181,7 +181,7 @@ class CefBrowser : public virtual CefBase {
/*--cef()--*/ /*--cef()--*/
virtual void GetFrameNames(std::vector<CefString>& names) =0; virtual void GetFrameNames(std::vector<CefString>& names) =0;
// ///
// Send a message to the specified |target_process|. Returns true if the // Send a message to the specified |target_process|. Returns true if the
// message was sent successfully. // message was sent successfully.
/// ///
@ -457,7 +457,6 @@ class CefBrowserHost : public virtual CefBase {
// specified visitor. If |current_only| is true only the current navigation // specified visitor. If |current_only| is true only the current navigation
// entry will be sent, otherwise all navigation entries will be sent. // entry will be sent, otherwise all navigation entries will be sent.
/// ///
///
/*--cef()--*/ /*--cef()--*/
virtual void GetNavigationEntries( virtual void GetNavigationEntries(
CefRefPtr<CefNavigationEntryVisitor> visitor, CefRefPtr<CefNavigationEntryVisitor> visitor,

2
include/cef_keyboard_handler.h
View File

@ -48,11 +48,13 @@
/*--cef(source=client)--*/ /*--cef(source=client)--*/
class CefKeyboardHandler : public virtual CefBase { class CefKeyboardHandler : public virtual CefBase {
public: public:
///
// Called before a keyboard event is sent to the renderer. |event| contains // Called before a keyboard event is sent to the renderer. |event| contains
// information about the keyboard event. |os_event| is the operating system // information about the keyboard event. |os_event| is the operating system
// event message, if any. Return true if the event was handled or false // event message, if any. Return true if the event was handled or false
// otherwise. If the event will be handled in OnKeyEvent() as a keyboard // otherwise. If the event will be handled in OnKeyEvent() as a keyboard
// shortcut set |is_keyboard_shortcut| to true and return false. // shortcut set |is_keyboard_shortcut| to true and return false.
///
/*--cef()--*/ /*--cef()--*/
virtual bool OnPreKeyEvent(CefRefPtr<CefBrowser> browser, virtual bool OnPreKeyEvent(CefRefPtr<CefBrowser> browser,
const CefKeyEvent& event, const CefKeyEvent& event,

1
include/cef_life_span_handler.h
View File

@ -70,6 +70,7 @@ class CefLifeSpanHandler : public virtual CefBase {
// source browser's values. If the |no_javascript_access| value is set to // source browser's values. If the |no_javascript_access| value is set to
// false the new browser will not be scriptable and may not be hosted in the // false the new browser will not be scriptable and may not be hosted in the
// same renderer process as the source browser. // same renderer process as the source browser.
///
/*--cef(optional_param=target_url,optional_param=target_frame_name)--*/ /*--cef(optional_param=target_url,optional_param=target_frame_name)--*/
virtual bool OnBeforePopup(CefRefPtr<CefBrowser> browser, virtual bool OnBeforePopup(CefRefPtr<CefBrowser> browser,
CefRefPtr<CefFrame> frame, CefRefPtr<CefFrame> frame,

60
include/cef_menu_model.h
View File

@ -63,26 +63,26 @@ class CefMenuModel : public virtual CefBase {
/*--cef()--*/ /*--cef()--*/
virtual int GetCount() =0; virtual int GetCount() =0;
// ///
// Add a separator to the menu. Returns true on success. // Add a separator to the menu. Returns true on success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool AddSeparator() =0; virtual bool AddSeparator() =0;
// ///
// Add an item to the menu. Returns true on success. // Add an item to the menu. Returns true on success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool AddItem(int command_id, virtual bool AddItem(int command_id,
const CefString& label) =0; const CefString& label) =0;
// ///
// Add a check item to the menu. Returns true on success. // Add a check item to the menu. Returns true on success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool AddCheckItem(int command_id, virtual bool AddCheckItem(int command_id,
const CefString& label) =0; const CefString& label) =0;
// ///
// Add a radio item to the menu. Only a single item with the specified // Add a radio item to the menu. Only a single item with the specified
// |group_id| can be checked at a time. Returns true on success. // |group_id| can be checked at a time. Returns true on success.
/// ///
@ -91,21 +91,21 @@ class CefMenuModel : public virtual CefBase {
const CefString& label, const CefString& label,
int group_id) =0; int group_id) =0;
// ///
// Add a sub-menu to the menu. The new sub-menu is returned. // Add a sub-menu to the menu. The new sub-menu is returned.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual CefRefPtr<CefMenuModel> AddSubMenu(int command_id, virtual CefRefPtr<CefMenuModel> AddSubMenu(int command_id,
const CefString& label) =0; const CefString& label) =0;
// ///
// Insert a separator in the menu at the specified |index|. Returns true on // Insert a separator in the menu at the specified |index|. Returns true on
// success. // success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool InsertSeparatorAt(int index) =0; virtual bool InsertSeparatorAt(int index) =0;
// ///
// Insert an item in the menu at the specified |index|. Returns true on // Insert an item in the menu at the specified |index|. Returns true on
// success. // success.
/// ///
@ -114,7 +114,7 @@ class CefMenuModel : public virtual CefBase {
int command_id, int command_id,
const CefString& label) =0; const CefString& label) =0;
// ///
// Insert a check item in the menu at the specified |index|. Returns true on // Insert a check item in the menu at the specified |index|. Returns true on
// success. // success.
/// ///
@ -123,7 +123,7 @@ class CefMenuModel : public virtual CefBase {
int command_id, int command_id,
const CefString& label) =0; const CefString& label) =0;
// ///
// Insert a radio item in the menu at the specified |index|. Only a single // Insert a radio item in the menu at the specified |index|. Only a single
// item with the specified |group_id| can be checked at a time. Returns true // item with the specified |group_id| can be checked at a time. Returns true
// on success. // on success.
@ -134,7 +134,7 @@ class CefMenuModel : public virtual CefBase {
const CefString& label, const CefString& label,
int group_id) =0; int group_id) =0;
// ///
// Insert a sub-menu in the menu at the specified |index|. The new sub-menu // Insert a sub-menu in the menu at the specified |index|. The new sub-menu
// is returned. // is returned.
/// ///
@ -248,99 +248,99 @@ class CefMenuModel : public virtual CefBase {
/*--cef()--*/ /*--cef()--*/
virtual CefRefPtr<CefMenuModel> GetSubMenuAt(int index) =0; virtual CefRefPtr<CefMenuModel> GetSubMenuAt(int index) =0;
// ///
// Returns true if the specified |command_id| is visible. // Returns true if the specified |command_id| is visible.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool IsVisible(int command_id) =0; virtual bool IsVisible(int command_id) =0;
// ///
// Returns true if the specified |index| is visible. // Returns true if the specified |index| is visible.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool IsVisibleAt(int index) =0; virtual bool IsVisibleAt(int index) =0;
// ///
// Change the visibility of the specified |command_id|. Returns true on // Change the visibility of the specified |command_id|. Returns true on
// success. // success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool SetVisible(int command_id, bool visible) =0; virtual bool SetVisible(int command_id, bool visible) =0;
// ///
// Change the visibility at the specified |index|. Returns true on success. // Change the visibility at the specified |index|. Returns true on success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool SetVisibleAt(int index, bool visible) =0; virtual bool SetVisibleAt(int index, bool visible) =0;
// ///
// Returns true if the specified |command_id| is enabled. // Returns true if the specified |command_id| is enabled.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool IsEnabled(int command_id) =0; virtual bool IsEnabled(int command_id) =0;
// ///
// Returns true if the specified |index| is enabled. // Returns true if the specified |index| is enabled.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool IsEnabledAt(int index) =0; virtual bool IsEnabledAt(int index) =0;
// ///
// Change the enabled status of the specified |command_id|. Returns true on // Change the enabled status of the specified |command_id|. Returns true on
// success. // success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool SetEnabled(int command_id, bool enabled) =0; virtual bool SetEnabled(int command_id, bool enabled) =0;
// ///
// Change the enabled status at the specified |index|. Returns true on // Change the enabled status at the specified |index|. Returns true on
// success. // success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool SetEnabledAt(int index, bool enabled) =0; virtual bool SetEnabledAt(int index, bool enabled) =0;
// ///
// Returns true if the specified |command_id| is checked. Only applies to // Returns true if the specified |command_id| is checked. Only applies to
// check and radio items. // check and radio items.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool IsChecked(int command_id) =0; virtual bool IsChecked(int command_id) =0;
// ///
// Returns true if the specified |index| is checked. Only applies to check // Returns true if the specified |index| is checked. Only applies to check
// and radio items. // and radio items.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool IsCheckedAt(int index) =0; virtual bool IsCheckedAt(int index) =0;
// ///
// Check the specified |command_id|. Only applies to check and radio items. // Check the specified |command_id|. Only applies to check and radio items.
// Returns true on success. // Returns true on success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool SetChecked(int command_id, bool checked) =0; virtual bool SetChecked(int command_id, bool checked) =0;
// ///
// Check the specified |index|. Only applies to check and radio items. Returns // Check the specified |index|. Only applies to check and radio items. Returns
// true on success. // true on success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool SetCheckedAt(int index, bool checked) =0; virtual bool SetCheckedAt(int index, bool checked) =0;
// ///
// Returns true if the specified |command_id| has a keyboard accelerator // Returns true if the specified |command_id| has a keyboard accelerator
// assigned. // assigned.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool HasAccelerator(int command_id) =0; virtual bool HasAccelerator(int command_id) =0;
// ///
// Returns true if the specified |index| has a keyboard accelerator assigned. // Returns true if the specified |index| has a keyboard accelerator assigned.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool HasAcceleratorAt(int index) =0; virtual bool HasAcceleratorAt(int index) =0;
// ///
// Set the keyboard accelerator for the specified |command_id|. |key_code| can // Set the keyboard accelerator for the specified |command_id|. |key_code| can
// be any virtual key or character value. Returns true on success. // be any virtual key or character value. Returns true on success.
/// ///
@ -351,7 +351,7 @@ class CefMenuModel : public virtual CefBase {
bool ctrl_pressed, bool ctrl_pressed,
bool alt_pressed) =0; bool alt_pressed) =0;
// ///
// Set the keyboard accelerator at the specified |index|. |key_code| can be // Set the keyboard accelerator at the specified |index|. |key_code| can be
// any virtual key or character value. Returns true on success. // any virtual key or character value. Returns true on success.
/// ///
@ -362,21 +362,21 @@ class CefMenuModel : public virtual CefBase {
bool ctrl_pressed, bool ctrl_pressed,
bool alt_pressed) =0; bool alt_pressed) =0;
// ///
// Remove the keyboard accelerator for the specified |command_id|. Returns // Remove the keyboard accelerator for the specified |command_id|. Returns
// true on success. // true on success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool RemoveAccelerator(int command_id) =0; virtual bool RemoveAccelerator(int command_id) =0;
// ///
// Remove the keyboard accelerator at the specified |index|. Returns true on // Remove the keyboard accelerator at the specified |index|. Returns true on
// success. // success.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual bool RemoveAcceleratorAt(int index) =0; virtual bool RemoveAcceleratorAt(int index) =0;
// ///
// Retrieves the keyboard accelerator for the specified |command_id|. Returns // Retrieves the keyboard accelerator for the specified |command_id|. Returns
// true on success. // true on success.
/// ///
@ -387,7 +387,7 @@ class CefMenuModel : public virtual CefBase {
bool& ctrl_pressed, bool& ctrl_pressed,
bool& alt_pressed) =0; bool& alt_pressed) =0;
// ///
// Retrieves the keyboard accelerator for the specified |index|. Returns true // Retrieves the keyboard accelerator for the specified |index|. Returns true
// on success. // on success.
/// ///

8
include/cef_parser.h
View File

@ -81,10 +81,12 @@ CefString CefFormatUrlForSecurityDisplay(const CefString& origin_url,
/*--cef()--*/ /*--cef()--*/
CefString CefGetMimeType(const CefString& extension); CefString CefGetMimeType(const CefString& extension);
///
// Get the extensions associated with the given mime type. This should be passed // Get the extensions associated with the given mime type. This should be passed
// in lower case. There could be multiple extensions for a given mime type, like // in lower case. There could be multiple extensions for a given mime type, like
// "html,htm" for "text/html", or "txt,text,html,..." for "text/*". Any existing // "html,htm" for "text/html", or "txt,text,html,..." for "text/*". Any existing
// elements in the provided vector will not be erased. // elements in the provided vector will not be erased.
///
/*--cef()--*/ /*--cef()--*/
void CefGetExtensionsForMimeType(const CefString& mime_type, void CefGetExtensionsForMimeType(const CefString& mime_type,
std::vector<CefString>& extensions); std::vector<CefString>& extensions);
@ -126,16 +128,20 @@ CefString CefURIDecode(const CefString& text,
bool convert_to_utf8, bool convert_to_utf8,
cef_uri_unescape_rule_t unescape_rule); cef_uri_unescape_rule_t unescape_rule);
///
// Parses the specified |json_string| and returns a dictionary or list // Parses the specified |json_string| and returns a dictionary or list
// representation. If JSON parsing fails this method returns NULL. // representation. If JSON parsing fails this method returns NULL.
///
/*--cef()--*/ /*--cef()--*/
CefRefPtr<CefValue> CefParseJSON(const CefString& json_string, CefRefPtr<CefValue> CefParseJSON(const CefString& json_string,
cef_json_parser_options_t options); cef_json_parser_options_t options);
///
// Parses the specified |json_string| and returns a dictionary or list // Parses the specified |json_string| and returns a dictionary or list
// representation. If JSON parsing fails this method returns NULL and populates // representation. If JSON parsing fails this method returns NULL and populates
// |error_code_out| and |error_msg_out| with an error code and a formatted error // |error_code_out| and |error_msg_out| with an error code and a formatted error
// message respectively. // message respectively.
///
/*--cef()--*/ /*--cef()--*/
CefRefPtr<CefValue> CefParseJSONAndReturnError( CefRefPtr<CefValue> CefParseJSONAndReturnError(
const CefString& json_string, const CefString& json_string,
@ -143,9 +149,11 @@ CefRefPtr<CefValue> CefParseJSONAndReturnError(
cef_json_parser_error_t& error_code_out, cef_json_parser_error_t& error_code_out,
CefString& error_msg_out); CefString& error_msg_out);
///
// Generates a JSON string from the specified root |node| which should be a // Generates a JSON string from the specified root |node| which should be a
// dictionary or list value. Returns an empty string on failure. This method // dictionary or list value. Returns an empty string on failure. This method
// requires exclusive access to |node| including any underlying data. // requires exclusive access to |node| including any underlying data.
///
/*--cef()--*/ /*--cef()--*/
CefString CefWriteJSON(CefRefPtr<CefValue> node, CefString CefWriteJSON(CefRefPtr<CefValue> node,
cef_json_writer_options_t options); cef_json_writer_options_t options);

2
include/cef_response_filter.h
View File

@ -56,6 +56,7 @@ class CefResponseFilter : public virtual CefBase {
/*--cef()--*/ /*--cef()--*/
virtual bool InitFilter() =0; virtual bool InitFilter() =0;
///
// Called to filter a chunk of data. |data_in| is the input buffer containing // Called to filter a chunk of data. |data_in| is the input buffer containing
// |data_in_size| bytes of pre-filter data (|data_in| will be NULL if // |data_in_size| bytes of pre-filter data (|data_in| will be NULL if
// |data_in_size| is zero). |data_out| is the output buffer that can accept up // |data_in_size| is zero). |data_out| is the output buffer that can accept up
@ -72,6 +73,7 @@ class CefResponseFilter : public virtual CefBase {
// matches |data_in_size| (all available pre-filter bytes have been read), and // matches |data_in_size| (all available pre-filter bytes have been read), and
// the method returns RESPONSE_FILTER_DONE or RESPONSE_FILTER_ERROR. Do not // the method returns RESPONSE_FILTER_DONE or RESPONSE_FILTER_ERROR. Do not
// keep a reference to the buffers passed to this method. // keep a reference to the buffers passed to this method.
///
/*--cef(optional_param=data_in,default_retval=RESPONSE_FILTER_ERROR)--*/ /*--cef(optional_param=data_in,default_retval=RESPONSE_FILTER_ERROR)--*/
virtual FilterStatus Filter(void* data_in, virtual FilterStatus Filter(void* data_in,
size_t data_in_size, size_t data_in_size,

19
tools/cef_parser.py
View File

@ -168,6 +168,21 @@ def get_comment(body, name):
result.reverse() result.reverse()
return result return result
def validate_comment(file, name, comment):
""" Validate the comment array returned by get_comment(). """
# Verify that the comment contains beginning and ending '///' as required by
# CppDoc (the leading '//' from each line will already have been removed by
# the get_comment() logic). There may be additional comments proceeding the
# CppDoc block so we look at the quantity of lines equaling '/' and expect
# the last line to be '/'.
docct = 0
for line in comment:
if not line is None and len(line) > 0 and line == '/':
docct = docct + 1
if docct != 2 or len(comment) < 3 or comment[len(comment)-1] != '/':
raise Exception('Missing or incorrect comment in %s for: %s' % \
(file, name))
def format_comment(comment, indent, translate_map = None, maxchars = 80): def format_comment(comment, indent, translate_map = None, maxchars = 80):
""" Return the comments array as a formatted string. """ """ Return the comments array as a formatted string. """
result = '' result = ''
@ -550,6 +565,7 @@ class obj_header:
# build the global function objects # build the global function objects
for attrib, retval, argval in list: for attrib, retval, argval in list:
comment = get_comment(data, retval+'('+argval+');') comment = get_comment(data, retval+'('+argval+');')
validate_comment(filename, retval, comment)
self.funcs.append(obj_function(self, filename, attrib, retval, self.funcs.append(obj_function(self, filename, attrib, retval,
argval, comment)) argval, comment))
@ -574,6 +590,7 @@ class obj_header:
# build the class objects # build the class objects
for attrib, name, parent_name, body in list: for attrib, name, parent_name, body in list:
comment = get_comment(data, name+' : public') comment = get_comment(data, name+' : public')
validate_comment(filename, name, comment)
self.classes.append( self.classes.append(
obj_class(self, filename, attrib, name, parent_name, body, obj_class(self, filename, attrib, name, parent_name, body,
comment, includes, forward_declares)) comment, includes, forward_declares))
@ -754,6 +771,7 @@ class obj_class:
self.staticfuncs = [] self.staticfuncs = []
for attrib, retval, argval in list: for attrib, retval, argval in list:
comment = get_comment(body, retval+'('+argval+')') comment = get_comment(body, retval+'('+argval+')')
validate_comment(filename, retval, comment)
self.staticfuncs.append( self.staticfuncs.append(
obj_function_static(self, attrib, retval, argval, comment)) obj_function_static(self, attrib, retval, argval, comment))
@ -767,6 +785,7 @@ class obj_class:
self.virtualfuncs = [] self.virtualfuncs = []
for attrib, retval, argval, vfmod in list: for attrib, retval, argval, vfmod in list:
comment = get_comment(body, retval+'('+argval+')') comment = get_comment(body, retval+'('+argval+')')
validate_comment(filename, retval, comment)
self.virtualfuncs.append( self.virtualfuncs.append(
obj_function_virtual(self, attrib, retval, argval, comment, obj_function_virtual(self, attrib, retval, argval, comment,
vfmod)) vfmod))

2
tools/distrib/mac/README.redistrib.txt
View File

@ -45,7 +45,7 @@ install_name_tool and a path relative to @executable_path.
The "cefclient Helper" app is used for executing separate processes (renderer, The "cefclient Helper" app is used for executing separate processes (renderer,
plugin, etc) with different characteristics. It needs to have a separate app plugin, etc) with different characteristics. It needs to have a separate app
bundle and Info.plist files so that, among other things, it does not show dock bundle and Info.plist file so that, among other things, it doesn’t show dock
icons. icons.
Required components: Required components:

5
tools/distrib/win/README.standard.txt
View File

@ -25,9 +25,8 @@ Release Contains libcef.dll, libcef.lib and other components required to
executable and will be copied there as part of the build process. executable and will be copied there as part of the build process.
Resources Contains resources required by libcef.dll. By default these files Resources Contains resources required by libcef.dll. By default these files
should be placed in the same directory as libcef.dll. By default should be placed in the same directory as libcef.dll and will be
these files should be placed in the same directory as libcef.dll copied there as part of the build process.
and will be copied there as part of the build process.
USAGE USAGE

2
tools/make_cppdocs.bat
View File

@ -12,7 +12,7 @@ set CPPDOC_REV="%1"
if not exist %CPPDOC_EXE% ( if not exist %CPPDOC_EXE% (
echo ERROR: Please install CppDoc from http://www.cppdoc.com/ echo ERROR: Please install CppDoc from http://www.cppdoc.com/
) else ( ) else (
%CPPDOC_EXE% -overwrite -title="CEF3 C++ API Docs - Revision %CPPDOC_REV%" -footer="<center><a href="http://code.google.com/p/chromiumembedded" target="_top">Chromium Embedded Framework (CEF)</a> Copyright &copy 2012 Marshall A. Greenblatt</center>" -namespace-as-project -comment-format="///;//;///" -classdir=projects -module="cppdoc-standard" -extensions=h -languages="c=cpp,cc=cpp,cpp=cpp,cs=csharp,cxx=cpp,h=cpp,hpp=cpp,hxx=cpp,java=java" -D"OS_WIN" -D"USING_CEF_SHARED" -D"__cplusplus" -D"CEF_STRING_TYPE_UTF16" -enable-author=false -enable-deprecations=true -enable-since=true -enable-version=false -file-links-for-globals=false -generate-deprecations-list=false -generate-hierarchy=true -header-background-dark="#ccccff" -header-background-light="#eeeeff" -include-private=false -include-protected=true -index-file-base=index -overview-html=overview.html -reduce-summary-font=true -selected-text-background=navy -selected-text-foreground=white -separate-index-pages=false -show-cppdoc-version=false -show-timestamp=false -summary-html=project.html -suppress-details=false -suppress-frames-links=false -table-background=white -wrap-long-lines=false ..\include #cef_runnable.h #cef_tuple.h #capi "..\docs\index.html" %CPPDOC_EXE% -overwrite -title="CEF3 C++ API Docs - Revision %CPPDOC_REV%" -footer="<center><a href="https://bitbucket.org/chromiumembedded/cef" target="_top">Chromium Embedded Framework (CEF)</a> Copyright &copy 2016 Marshall A. Greenblatt</center>" -namespace-as-project -comment-format="///;//;///" -classdir=projects -module="cppdoc-standard" -extensions=h -languages="c=cpp,cc=cpp,cpp=cpp,cs=csharp,cxx=cpp,h=cpp,hpp=cpp,hxx=cpp,java=java" -D"OS_WIN" -D"USING_CEF_SHARED" -D"__cplusplus" -D"CEF_STRING_TYPE_UTF16" -enable-author=false -enable-deprecations=true -enable-since=true -enable-version=false -file-links-for-globals=false -generate-deprecations-list=false -generate-hierarchy=true -header-background-dark="#ccccff" -header-background-light="#eeeeff" -include-private=false -include-protected=true -index-file-base=index -overview-html=overview.html -reduce-summary-font=true -selected-text-background=navy -selected-text-foreground=white -separate-index-pages=false -show-cppdoc-version=false -show-timestamp=false -summary-html=project.html -suppress-details=false -suppress-frames-links=false -table-background=white -wrap-long-lines=false ..\include #cef_runnable.h #cef_tuple.h #capi "..\docs\index.html"
) )
endlocal endlocal