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
@ -46,8 +46,8 @@ class CefPostData;
|
||||
class CefPostDataElement;
|
||||
|
||||
///
|
||||
// Class used to represent a web request. The methods of this class may be
|
||||
// called on any thread.
|
||||
/// Class used to represent a web request. The methods of this class may be
|
||||
/// called on any thread.
|
||||
///
|
||||
/*--cef(source=library,no_debugct_check)--*/
|
||||
class CefRequest : public virtual CefBaseRefCounted {
|
||||
@ -58,101 +58,101 @@ class CefRequest : public virtual CefBaseRefCounted {
|
||||
typedef cef_transition_type_t TransitionType;
|
||||
|
||||
///
|
||||
// Create a new CefRequest object.
|
||||
/// Create a new CefRequest object.
|
||||
///
|
||||
/*--cef()--*/
|
||||
static CefRefPtr<CefRequest> Create();
|
||||
|
||||
///
|
||||
// Returns true if this object is read-only.
|
||||
/// Returns true if this object is read-only.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsReadOnly() = 0;
|
||||
|
||||
///
|
||||
// Get the fully qualified URL.
|
||||
/// Get the fully qualified URL.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetURL() = 0;
|
||||
|
||||
///
|
||||
// Set the fully qualified URL.
|
||||
/// Set the fully qualified URL.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetURL(const CefString& url) = 0;
|
||||
|
||||
///
|
||||
// Get the request method type. The value will default to POST if post data
|
||||
// is provided and GET otherwise.
|
||||
/// Get the request method type. The value will default to POST if post data
|
||||
/// is provided and GET otherwise.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetMethod() = 0;
|
||||
|
||||
///
|
||||
// Set the request method type.
|
||||
/// Set the request method type.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetMethod(const CefString& method) = 0;
|
||||
|
||||
///
|
||||
// Set the referrer URL and policy. If non-empty the referrer URL must be
|
||||
// fully qualified with an HTTP or HTTPS scheme component. Any username,
|
||||
// password or ref component will be removed.
|
||||
/// Set the referrer URL and policy. If non-empty the referrer URL must be
|
||||
/// fully qualified with an HTTP or HTTPS scheme component. Any username,
|
||||
/// password or ref component will be removed.
|
||||
///
|
||||
/*--cef(optional_param=referrer_url)--*/
|
||||
virtual void SetReferrer(const CefString& referrer_url,
|
||||
ReferrerPolicy policy) = 0;
|
||||
|
||||
///
|
||||
// Get the referrer URL.
|
||||
/// Get the referrer URL.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetReferrerURL() = 0;
|
||||
|
||||
///
|
||||
// Get the referrer policy.
|
||||
/// Get the referrer policy.
|
||||
///
|
||||
/*--cef(default_retval=REFERRER_POLICY_DEFAULT)--*/
|
||||
virtual ReferrerPolicy GetReferrerPolicy() = 0;
|
||||
|
||||
///
|
||||
// Get the post data.
|
||||
/// Get the post data.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefPostData> GetPostData() = 0;
|
||||
|
||||
///
|
||||
// Set the post data.
|
||||
/// Set the post data.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetPostData(CefRefPtr<CefPostData> postData) = 0;
|
||||
|
||||
///
|
||||
// Get the header values. Will not include the Referer value if any.
|
||||
/// Get the header values. Will not include the Referer value if any.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void GetHeaderMap(HeaderMap& headerMap) = 0;
|
||||
|
||||
///
|
||||
// Set the header values. If a Referer value exists in the header map it will
|
||||
// be removed and ignored.
|
||||
/// Set the header values. If a Referer value exists in the header map it will
|
||||
/// be removed and ignored.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetHeaderMap(const HeaderMap& headerMap) = 0;
|
||||
|
||||
///
|
||||
// Returns the first header value for |name| or an empty string if not found.
|
||||
// Will not return the Referer value if any. Use GetHeaderMap instead if
|
||||
// |name| might have multiple values.
|
||||
/// Returns the first header value for |name| or an empty string if not found.
|
||||
/// Will not return the Referer value if any. Use GetHeaderMap instead if
|
||||
/// |name| might have multiple values.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetHeaderByName(const CefString& name) = 0;
|
||||
|
||||
///
|
||||
// Set the header |name| to |value|. If |overwrite| is true any existing
|
||||
// values will be replaced with the new value. If |overwrite| is false any
|
||||
// existing values will not be overwritten. The Referer value cannot be set
|
||||
// using this method.
|
||||
/// Set the header |name| to |value|. If |overwrite| is true any existing
|
||||
/// values will be replaced with the new value. If |overwrite| is false any
|
||||
/// existing values will not be overwritten. The Referer value cannot be set
|
||||
/// using this method.
|
||||
///
|
||||
/*--cef(optional_param=value)--*/
|
||||
virtual void SetHeaderByName(const CefString& name,
|
||||
@ -160,7 +160,7 @@ class CefRequest : public virtual CefBaseRefCounted {
|
||||
bool overwrite) = 0;
|
||||
|
||||
///
|
||||
// Set all values at one time.
|
||||
/// Set all values at one time.
|
||||
///
|
||||
/*--cef(optional_param=postData)--*/
|
||||
virtual void Set(const CefString& url,
|
||||
@ -169,60 +169,60 @@ class CefRequest : public virtual CefBaseRefCounted {
|
||||
const HeaderMap& headerMap) = 0;
|
||||
|
||||
///
|
||||
// Get the flags used in combination with CefURLRequest. See
|
||||
// cef_urlrequest_flags_t for supported values.
|
||||
/// Get the flags used in combination with CefURLRequest. See
|
||||
/// cef_urlrequest_flags_t for supported values.
|
||||
///
|
||||
/*--cef(default_retval=UR_FLAG_NONE)--*/
|
||||
virtual int GetFlags() = 0;
|
||||
|
||||
///
|
||||
// Set the flags used in combination with CefURLRequest. See
|
||||
// cef_urlrequest_flags_t for supported values.
|
||||
/// Set the flags used in combination with CefURLRequest. See
|
||||
/// cef_urlrequest_flags_t for supported values.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetFlags(int flags) = 0;
|
||||
|
||||
///
|
||||
// Get the URL to the first party for cookies used in combination with
|
||||
// CefURLRequest.
|
||||
/// Get the URL to the first party for cookies used in combination with
|
||||
/// CefURLRequest.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetFirstPartyForCookies() = 0;
|
||||
|
||||
///
|
||||
// Set the URL to the first party for cookies used in combination with
|
||||
// CefURLRequest.
|
||||
/// Set the URL to the first party for cookies used in combination with
|
||||
/// CefURLRequest.
|
||||
///
|
||||
/*--cef(optional_param=url)--*/
|
||||
virtual void SetFirstPartyForCookies(const CefString& url) = 0;
|
||||
|
||||
///
|
||||
// Get the resource type for this request. Only available in the browser
|
||||
// process.
|
||||
/// Get the resource type for this request. Only available in the browser
|
||||
/// process.
|
||||
///
|
||||
/*--cef(default_retval=RT_SUB_RESOURCE)--*/
|
||||
virtual ResourceType GetResourceType() = 0;
|
||||
|
||||
///
|
||||
// Get the transition type for this request. Only available in the browser
|
||||
// process and only applies to requests that represent a main frame or
|
||||
// sub-frame navigation.
|
||||
/// Get the transition type for this request. Only available in the browser
|
||||
/// process and only applies to requests that represent a main frame or
|
||||
/// sub-frame navigation.
|
||||
///
|
||||
/*--cef(default_retval=TT_EXPLICIT)--*/
|
||||
virtual TransitionType GetTransitionType() = 0;
|
||||
|
||||
///
|
||||
// Returns the globally unique identifier for this request or 0 if not
|
||||
// specified. Can be used by CefResourceRequestHandler implementations in the
|
||||
// browser process to track a single request across multiple callbacks.
|
||||
/// Returns the globally unique identifier for this request or 0 if not
|
||||
/// specified. Can be used by CefResourceRequestHandler implementations in the
|
||||
/// browser process to track a single request across multiple callbacks.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual uint64 GetIdentifier() = 0;
|
||||
};
|
||||
|
||||
///
|
||||
// Class used to represent post data for a web request. The methods of this
|
||||
// class may be called on any thread.
|
||||
/// Class used to represent post data for a web request. The methods of this
|
||||
/// class may be called on any thread.
|
||||
///
|
||||
/*--cef(source=library,no_debugct_check)--*/
|
||||
class CefPostData : public virtual CefBaseRefCounted {
|
||||
@ -230,122 +230,122 @@ class CefPostData : public virtual CefBaseRefCounted {
|
||||
typedef std::vector<CefRefPtr<CefPostDataElement>> ElementVector;
|
||||
|
||||
///
|
||||
// Create a new CefPostData object.
|
||||
/// Create a new CefPostData object.
|
||||
///
|
||||
/*--cef()--*/
|
||||
static CefRefPtr<CefPostData> Create();
|
||||
|
||||
///
|
||||
// Returns true if this object is read-only.
|
||||
/// Returns true if this object is read-only.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsReadOnly() = 0;
|
||||
|
||||
///
|
||||
// Returns true if the underlying POST data includes elements that are not
|
||||
// represented by this CefPostData object (for example, multi-part file upload
|
||||
// data). Modifying CefPostData objects with excluded elements may result in
|
||||
// the request failing.
|
||||
/// Returns true if the underlying POST data includes elements that are not
|
||||
/// represented by this CefPostData object (for example, multi-part file
|
||||
/// upload data). Modifying CefPostData objects with excluded elements may
|
||||
/// result in the request failing.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool HasExcludedElements() = 0;
|
||||
|
||||
///
|
||||
// Returns the number of existing post data elements.
|
||||
/// Returns the number of existing post data elements.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual size_t GetElementCount() = 0;
|
||||
|
||||
///
|
||||
// Retrieve the post data elements.
|
||||
/// Retrieve the post data elements.
|
||||
///
|
||||
/*--cef(count_func=elements:GetElementCount)--*/
|
||||
virtual void GetElements(ElementVector& elements) = 0;
|
||||
|
||||
///
|
||||
// Remove the specified post data element. Returns true if the removal
|
||||
// succeeds.
|
||||
/// Remove the specified post data element. Returns true if the removal
|
||||
/// succeeds.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool RemoveElement(CefRefPtr<CefPostDataElement> element) = 0;
|
||||
|
||||
///
|
||||
// Add the specified post data element. Returns true if the add succeeds.
|
||||
/// Add the specified post data element. Returns true if the add succeeds.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool AddElement(CefRefPtr<CefPostDataElement> element) = 0;
|
||||
|
||||
///
|
||||
// Remove all existing post data elements.
|
||||
/// Remove all existing post data elements.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void RemoveElements() = 0;
|
||||
};
|
||||
|
||||
///
|
||||
// Class used to represent a single element in the request post data. The
|
||||
// methods of this class may be called on any thread.
|
||||
/// Class used to represent a single element in the request post data. The
|
||||
/// methods of this class may be called on any thread.
|
||||
///
|
||||
/*--cef(source=library,no_debugct_check)--*/
|
||||
class CefPostDataElement : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Post data elements may represent either bytes or files.
|
||||
/// Post data elements may represent either bytes or files.
|
||||
///
|
||||
typedef cef_postdataelement_type_t Type;
|
||||
|
||||
///
|
||||
// Create a new CefPostDataElement object.
|
||||
/// Create a new CefPostDataElement object.
|
||||
///
|
||||
/*--cef()--*/
|
||||
static CefRefPtr<CefPostDataElement> Create();
|
||||
|
||||
///
|
||||
// Returns true if this object is read-only.
|
||||
/// Returns true if this object is read-only.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsReadOnly() = 0;
|
||||
|
||||
///
|
||||
// Remove all contents from the post data element.
|
||||
/// Remove all contents from the post data element.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetToEmpty() = 0;
|
||||
|
||||
///
|
||||
// The post data element will represent a file.
|
||||
/// The post data element will represent a file.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetToFile(const CefString& fileName) = 0;
|
||||
|
||||
///
|
||||
// The post data element will represent bytes. The bytes passed
|
||||
// in will be copied.
|
||||
/// The post data element will represent bytes. The bytes passed
|
||||
/// in will be copied.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void SetToBytes(size_t size, const void* bytes) = 0;
|
||||
|
||||
///
|
||||
// Return the type of this post data element.
|
||||
/// Return the type of this post data element.
|
||||
///
|
||||
/*--cef(default_retval=PDE_TYPE_EMPTY)--*/
|
||||
virtual Type GetType() = 0;
|
||||
|
||||
///
|
||||
// Return the file name.
|
||||
/// Return the file name.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefString GetFile() = 0;
|
||||
|
||||
///
|
||||
// Return the number of bytes.
|
||||
/// Return the number of bytes.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual size_t GetBytesCount() = 0;
|
||||
|
||||
///
|
||||
// Read up to |size| bytes into |bytes| and return the number of bytes
|
||||
// actually read.
|
||||
/// Read up to |size| bytes into |bytes| and return the number of bytes
|
||||
/// actually read.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual size_t GetBytes(size_t size, void* bytes) = 0;
|
||||
|
||||
Reference in New Issue
Block a user