mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
Marshall Greenblatt
@ -47,37 +47,38 @@ class CefSetCookieCallback;
|
||||
class CefDeleteCookiesCallback;
|
||||
|
||||
///
|
||||
// Class used for managing cookies. The methods of this class may be called on
|
||||
// any thread unless otherwise indicated.
|
||||
/// Class used for managing cookies. The methods of this class may be called on
|
||||
/// any thread unless otherwise indicated.
|
||||
///
|
||||
/*--cef(source=library,no_debugct_check)--*/
|
||||
class CefCookieManager : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// 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 method is equivalent to
|
||||
// calling CefRequestContext::GetGlobalContext()->GetDefaultCookieManager().
|
||||
/// 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 method is
|
||||
/// equivalent to calling
|
||||
/// CefRequestContext::GetGlobalContext()->GetDefaultCookieManager().
|
||||
///
|
||||
/*--cef(optional_param=callback)--*/
|
||||
static CefRefPtr<CefCookieManager> GetGlobalManager(
|
||||
CefRefPtr<CefCompletionCallback> callback);
|
||||
|
||||
///
|
||||
// Visit all cookies on the UI thread. The returned cookies are ordered by
|
||||
// longest path, then by earliest creation date. Returns false 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 if cookies
|
||||
/// cannot be accessed.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool VisitAllCookies(CefRefPtr<CefCookieVisitor> visitor) = 0;
|
||||
|
||||
///
|
||||
// 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
|
||||
// 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 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
|
||||
/// 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 if cookies cannot be accessed.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool VisitUrlCookies(const CefString& url,
|
||||
@ -85,13 +86,13 @@ class CefCookieManager : public virtual CefBaseRefCounted {
|
||||
CefRefPtr<CefCookieVisitor> visitor) = 0;
|
||||
|
||||
///
|
||||
// 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 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 if an invalid URL is specified or if cookies cannot be accessed.
|
||||
///
|
||||
/*--cef(optional_param=callback)--*/
|
||||
virtual bool SetCookie(const CefString& url,
|
||||
@ -99,15 +100,15 @@ class CefCookieManager : public virtual CefBaseRefCounted {
|
||||
CefRefPtr<CefSetCookieCallback> callback) = 0;
|
||||
|
||||
///
|
||||
// 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 empty 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 if a non-empty invalid URL is
|
||||
// specified or if cookies cannot be accessed. Cookies can alternately be
|
||||
// deleted using the Visit*Cookies() methods.
|
||||
/// 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 empty
|
||||
/// 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 if a non-empty invalid URL is
|
||||
/// specified or if cookies cannot be accessed. Cookies can alternately be
|
||||
/// deleted using the Visit*Cookies() methods.
|
||||
///
|
||||
/*--cef(optional_param=url,optional_param=cookie_name,
|
||||
optional_param=callback)--*/
|
||||
@ -116,27 +117,27 @@ class CefCookieManager : public virtual CefBaseRefCounted {
|
||||
CefRefPtr<CefDeleteCookiesCallback> callback) = 0;
|
||||
|
||||
///
|
||||
// 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 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 if cookies cannot be accessed.
|
||||
///
|
||||
/*--cef(optional_param=callback)--*/
|
||||
virtual bool FlushStore(CefRefPtr<CefCompletionCallback> callback) = 0;
|
||||
};
|
||||
|
||||
///
|
||||
// Interface to implement for visiting cookie values. The methods of this class
|
||||
// will always be called on the UI thread.
|
||||
/// Interface to implement for visiting cookie values. The methods of this class
|
||||
/// will always be called on the UI thread.
|
||||
///
|
||||
/*--cef(source=client)--*/
|
||||
class CefCookieVisitor : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// 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 to delete the cookie currently being visited.
|
||||
// Return false to stop visiting cookies. This method 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 to delete the cookie currently being visited.
|
||||
/// Return false to stop visiting cookies. This method may never be called if
|
||||
/// no cookies are found.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool Visit(const CefCookie& cookie,
|
||||
@ -146,30 +147,30 @@ class CefCookieVisitor : public virtual CefBaseRefCounted {
|
||||
};
|
||||
|
||||
///
|
||||
// Interface to implement to be notified of asynchronous completion via
|
||||
// CefCookieManager::SetCookie().
|
||||
/// Interface to implement to be notified of asynchronous completion via
|
||||
/// CefCookieManager::SetCookie().
|
||||
///
|
||||
/*--cef(source=client)--*/
|
||||
class CefSetCookieCallback : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Method that will be called upon completion. |success| will be true if the
|
||||
// cookie was set successfully.
|
||||
/// Method that will be called upon completion. |success| will be true if the
|
||||
/// cookie was set successfully.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnComplete(bool success) = 0;
|
||||
};
|
||||
|
||||
///
|
||||
// Interface to implement to be notified of asynchronous completion via
|
||||
// CefCookieManager::DeleteCookies().
|
||||
/// Interface to implement to be notified of asynchronous completion via
|
||||
/// CefCookieManager::DeleteCookies().
|
||||
///
|
||||
/*--cef(source=client)--*/
|
||||
class CefDeleteCookiesCallback : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// 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.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnComplete(int num_deleted) = 0;
|
||||
|
||||
Reference in New Issue
Block a user