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

74
include/cef_drag_data.h
View File

@ -44,179 +44,179 @@
#include "include/cef_stream.h"
///
// Class used to represent drag data. The methods of this class may be called
// on any thread.
/// Class used to represent drag data. The methods of this class may be called
/// on any thread.
///
/*--cef(source=library)--*/
class CefDragData : public virtual CefBaseRefCounted {
public:
///
// Create a new CefDragData object.
/// Create a new CefDragData object.
///
/*--cef()--*/
static CefRefPtr<CefDragData> Create();
///
// Returns a copy of the current object.
/// Returns a copy of the current object.
///
/*--cef()--*/
virtual CefRefPtr<CefDragData> Clone() = 0;
///
// 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 drag data is a link.
/// Returns true if the drag data is a link.
///
/*--cef()--*/
virtual bool IsLink() = 0;
///
// Returns true if the drag data is a text or html fragment.
/// Returns true if the drag data is a text or html fragment.
///
/*--cef()--*/
virtual bool IsFragment() = 0;
///
// Returns true if the drag data is a file.
/// Returns true if the drag data is a file.
///
/*--cef()--*/
virtual bool IsFile() = 0;
///
// Return the link URL that is being dragged.
/// Return the link URL that is being dragged.
///
/*--cef()--*/
virtual CefString GetLinkURL() = 0;
///
// Return the title associated with the link being dragged.
/// Return the title associated with the link being dragged.
///
/*--cef()--*/
virtual CefString GetLinkTitle() = 0;
///
// Return the metadata, if any, associated with the link being dragged.
/// Return the metadata, if any, associated with the link being dragged.
///
/*--cef()--*/
virtual CefString GetLinkMetadata() = 0;
///
// Return the plain text fragment that is being dragged.
/// Return the plain text fragment that is being dragged.
///
/*--cef()--*/
virtual CefString GetFragmentText() = 0;
///
// Return the text/html fragment that is being dragged.
/// Return the text/html fragment that is being dragged.
///
/*--cef()--*/
virtual CefString GetFragmentHtml() = 0;
///
// Return the base URL that the fragment came from. This value is used for
// resolving relative URLs and may be empty.
/// Return the base URL that the fragment came from. This value is used for
/// resolving relative URLs and may be empty.
///
/*--cef()--*/
virtual CefString GetFragmentBaseURL() = 0;
///
// 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.
///
/*--cef()--*/
virtual CefString GetFileName() = 0;
///
// 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 method will return the size of the file contents in bytes.
// Call GetFileName() 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 method will return the size of the file contents in bytes.
/// Call GetFileName() to get a suggested name for the file.
///
/*--cef(optional_param=writer)--*/
virtual size_t GetFileContents(CefRefPtr<CefStreamWriter> writer) = 0;
///
// 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.
///
/*--cef()--*/
virtual bool GetFileNames(std::vector<CefString>& names) = 0;
///
// Set the link URL that is being dragged.
/// Set the link URL that is being dragged.
///
/*--cef(optional_param=url)--*/
virtual void SetLinkURL(const CefString& url) = 0;
///
// Set the title associated with the link being dragged.
/// Set the title associated with the link being dragged.
///
/*--cef(optional_param=title)--*/
virtual void SetLinkTitle(const CefString& title) = 0;
///
// Set the metadata associated with the link being dragged.
/// Set the metadata associated with the link being dragged.
///
/*--cef(optional_param=data)--*/
virtual void SetLinkMetadata(const CefString& data) = 0;
///
// Set the plain text fragment that is being dragged.
/// Set the plain text fragment that is being dragged.
///
/*--cef(optional_param=text)--*/
virtual void SetFragmentText(const CefString& text) = 0;
///
// Set the text/html fragment that is being dragged.
/// Set the text/html fragment that is being dragged.
///
/*--cef(optional_param=html)--*/
virtual void SetFragmentHtml(const CefString& html) = 0;
///
// Set the base URL that the fragment came from.
/// Set the base URL that the fragment came from.
///
/*--cef(optional_param=base_url)--*/
virtual void SetFragmentBaseURL(const CefString& base_url) = 0;
///
// Reset the file contents. You should do this before calling
// CefBrowserHost::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
/// CefBrowserHost::DragTargetDragEnter as the web view does not allow us to
/// drag in this kind of data.
///
/*--cef()--*/
virtual void ResetFileContents() = 0;
///
// Add a file that is being dragged into the webview.
/// Add a file that is being dragged into the webview.
///
/*--cef(optional_param=display_name)--*/
virtual void AddFile(const CefString& path,
const CefString& display_name) = 0;
///
// Clear list of filenames.
/// Clear list of filenames.
///
/*--cef()--*/
virtual void ClearFilenames() = 0;
///
// 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.
///
/*--cef()--*/
virtual CefRefPtr<CefImage> GetImage() = 0;
///
// Get the image hotspot (drag start location relative to image dimensions).
/// Get the image hotspot (drag start location relative to image dimensions).
///
/*--cef()--*/
virtual CefPoint GetImageHotspot() = 0;
///
// Returns true if an image representation of drag data is available.
/// Returns true if an image representation of drag data is available.
///
/*--cef()--*/
virtual bool HasImage() = 0;