bcarrella/cef
1
0
Fork 0
mirror of https://bitbucket.org/chromiumembedded/cef synced 2025-06-05 21:39:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update include/ comments to Doxygen formatting (see issue #3384)

Browse Source 
See related guidelines in the issue.
This commit is contained in:
Marshall Greenblatt
2022-08-31 22:03:04 -04:00
parent 7b352159df
commit d7a153bdd4
235 changed files with 11484 additions and 11274 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
include/cef_jsdialog_handler.h
View File

@ -42,23 +42,23 @@
#include "include/cef_browser.h"
///
// Callback interface used for asynchronous continuation of JavaScript dialog
// requests.
/// Callback interface used for asynchronous continuation of JavaScript dialog
/// requests.
///
/*--cef(source=library)--*/
class CefJSDialogCallback : public virtual CefBaseRefCounted {
public:
///
// Continue the JS dialog request. Set |success| to true if the OK button was
// pressed. The |user_input| value should be specified for prompt dialogs.
/// Continue the JS dialog request. Set |success| to true if the OK button was
/// pressed. The |user_input| value should be specified for prompt dialogs.
///
/*--cef(capi_name=cont,optional_param=user_input)--*/
virtual void Continue(bool success, const CefString& user_input) = 0;
};
///
// Implement this interface to handle events related to JavaScript dialogs. The
// methods of this class will be called on the UI thread.
/// Implement this interface to handle events related to JavaScript dialogs. The
/// methods of this class will be called on the UI thread.
///
/*--cef(source=client)--*/
class CefJSDialogHandler : public virtual CefBaseRefCounted {
@ -66,20 +66,20 @@ class CefJSDialogHandler : public virtual CefBaseRefCounted {
typedef cef_jsdialog_type_t JSDialogType;
///
// Called to run a JavaScript dialog. If |origin_url| is non-empty it can be
// passed to the CefFormatUrlForSecurityDisplay function to retrieve a secure
// and user-friendly display string. The |default_prompt_text| value will be
// specified for prompt dialogs only. Set |suppress_message| to true and
// return false to suppress the message (suppressing messages is preferable to
// immediately executing the callback as this is used to detect presumably
// malicious behavior like spamming alert messages in onbeforeunload). Set
// |suppress_message| to false and return false to use the default
// implementation (the default implementation will show one modal dialog at a
// time and suppress any additional dialog requests until the displayed dialog
// is dismissed). Return true if the application will use a custom dialog or
// if the callback has been executed immediately. Custom dialogs may be either
// modal or modeless. If a custom dialog is used the application must execute
// |callback| once the custom dialog is dismissed.
/// Called to run a JavaScript dialog. If |origin_url| is non-empty it can be
/// passed to the CefFormatUrlForSecurityDisplay function to retrieve a secure
/// and user-friendly display string. The |default_prompt_text| value will be
/// specified for prompt dialogs only. Set |suppress_message| to true and
/// return false to suppress the message (suppressing messages is preferable
/// to immediately executing the callback as this is used to detect presumably
/// malicious behavior like spamming alert messages in onbeforeunload). Set
/// |suppress_message| to false and return false to use the default
/// implementation (the default implementation will show one modal dialog at a
/// time and suppress any additional dialog requests until the displayed
/// dialog is dismissed). Return true if the application will use a custom
/// dialog or if the callback has been executed immediately. Custom dialogs
/// may be either modal or modeless. If a custom dialog is used the
/// application must execute |callback| once the custom dialog is dismissed.
///
/*--cef(optional_param=origin_url,optional_param=accept_lang,
optional_param=message_text,optional_param=default_prompt_text)--*/
@ -94,12 +94,12 @@ class CefJSDialogHandler : public virtual CefBaseRefCounted {
}
///
// Called to run a dialog asking the user if they want to leave a page. Return
// false to use the default dialog implementation. Return true if the
// application will use a custom dialog or if the callback has been executed
// immediately. Custom dialogs may be either modal or modeless. If a custom
// dialog is used the application must execute |callback| once the custom
// dialog is dismissed.
/// Called to run a dialog asking the user if they want to leave a page.
/// Return false to use the default dialog implementation. Return true if the
/// application will use a custom dialog or if the callback has been executed
/// immediately. Custom dialogs may be either modal or modeless. If a custom
/// dialog is used the application must execute |callback| once the custom
/// dialog is dismissed.
///
/*--cef(optional_param=message_text)--*/
virtual bool OnBeforeUnloadDialog(CefRefPtr<CefBrowser> browser,
@ -110,15 +110,15 @@ class CefJSDialogHandler : public virtual CefBaseRefCounted {
}
///
// Called to cancel any pending dialogs and reset any saved dialog state. Will
// be called due to events like page navigation irregardless of whether any
// dialogs are currently pending.
/// Called to cancel any pending dialogs and reset any saved dialog state.
/// Will be called due to events like page navigation irregardless of whether
/// any dialogs are currently pending.
///
/*--cef()--*/
virtual void OnResetDialogState(CefRefPtr<CefBrowser> browser) {}
///
// Called when the dialog is closed.
/// Called when the dialog is closed.
///
/*--cef()--*/
virtual void OnDialogClosed(CefRefPtr<CefBrowser> browser) {}