Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

(default)
Class CefDragData

CefBaseRefCounted
   |
   +--CefDragData

   in cef_drag_data.h

class CefDragData
extends CefBaseRefCounted

Class used to represent drag data. The methods of this class may be called on any thread.


Method Summary
 virtual void AddFile( const CefString& path, const CefString& display_name )= 0
          Add a file that is being dragged into the webview.
 virtual CefRefPtr< CefDragData > Clone()= 0
          Returns a copy of the current object.
 static CefRefPtr< CefDragData > Create()
          Create a new CefDragData object.
 virtual size_t GetFileContents( CefRefPtr< CefStreamWriter > writer )= 0
          Write the contents of the file being dragged out of the web view into |writer|.
 virtual CefString GetFileName()= 0
          Return the name of the file being dragged out of the browser window.
 virtual bool GetFileNames( std::vector< CefString >& names )= 0
          Retrieve the list of file names that are being dragged into the browser window.
 virtual CefString GetFragmentBaseURL()= 0
          Return the base URL that the fragment came from.
 virtual CefString GetFragmentHtml()= 0
          Return the text/html fragment that is being dragged.
 virtual CefString GetFragmentText()= 0
          Return the plain text fragment that is being dragged.
 virtual CefRefPtr< CefImage > GetImage()= 0
          Get the image representation of drag data.
 virtual CefPoint GetImageHotspot()= 0
          Get the image hotspot (drag start location relative to image dimensions).
 virtual CefString GetLinkMetadata()= 0
          Return the metadata, if any, associated with the link being dragged.
 virtual CefString GetLinkTitle()= 0
          Return the title associated with the link being dragged.
 virtual CefString GetLinkURL()= 0
          Return the link URL that is being dragged.
 virtual bool HasImage()= 0
          Returns true if an image representation of drag data is available.
 virtual bool IsFile()= 0
          Returns true if the drag data is a file.
 virtual bool IsFragment()= 0
          Returns true if the drag data is a text or html fragment.
 virtual bool IsLink()= 0
          Returns true if the drag data is a link.
 virtual bool IsReadOnly()= 0
          Returns true if this object is read-only.
 virtual void ResetFileContents()= 0
          Reset the file contents.
 virtual void SetFragmentBaseURL( const CefString& base_url )= 0
          Set the base URL that the fragment came from.
 virtual void SetFragmentHtml( const CefString& html )= 0
          Set the text/html fragment that is being dragged.
 virtual void SetFragmentText( const CefString& text )= 0
          Set the plain text fragment that is being dragged.
 virtual void SetLinkMetadata( const CefString& data )= 0
          Set the metadata associated with the link being dragged.
 virtual void SetLinkTitle( const CefString& title )= 0
          Set the title associated with the link being dragged.
 virtual void SetLinkURL( const CefString& url )= 0
          Set the link URL that is being dragged.
   
Methods inherited from class CefBaseRefCounted
AddRef, Release, HasOneRef, HasAtLeastOneRef
 

Method Detail

AddFile

public virtual void AddFile( const CefString& path, const CefString& display_name )= 0;
Add a file that is being dragged into the webview.

Clone

public virtual CefRefPtr< CefDragData > Clone()= 0;
Returns a copy of the current object.

Create

public static CefRefPtr< CefDragData > Create();
Create a new CefDragData object.

GetFileContents

public virtual size_t GetFileContents( CefRefPtr< CefStreamWriter > writer )= 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.

GetFileName

public virtual CefString GetFileName()= 0;
Return the name of the file being dragged out of the browser window.

GetFileNames

public virtual bool GetFileNames( std::vector< CefString >& names )= 0;
Retrieve the list of file names that are being dragged into the browser window.

GetFragmentBaseURL

public virtual CefString GetFragmentBaseURL()= 0;
Return the base URL that the fragment came from. This value is used for resolving relative URLs and may be empty.

GetFragmentHtml

public virtual CefString GetFragmentHtml()= 0;
Return the text/html fragment that is being dragged.

GetFragmentText

public virtual CefString GetFragmentText()= 0;
Return the plain text fragment that is being dragged.

GetImage

public virtual CefRefPtr< CefImage > GetImage()= 0;
Get the image representation of drag data. May return NULL if no image representation is available.

GetImageHotspot

public virtual CefPoint GetImageHotspot()= 0;
Get the image hotspot (drag start location relative to image dimensions).

GetLinkMetadata

public virtual CefString GetLinkMetadata()= 0;
Return the metadata, if any, associated with the link being dragged.

GetLinkTitle

public virtual CefString GetLinkTitle()= 0;
Return the title associated with the link being dragged.

GetLinkURL

public virtual CefString GetLinkURL()= 0;
Return the link URL that is being dragged.

HasImage

public virtual bool HasImage()= 0;
Returns true if an image representation of drag data is available.

IsFile

public virtual bool IsFile()= 0;
Returns true if the drag data is a file.

IsFragment

public virtual bool IsFragment()= 0;
Returns true if the drag data is a text or html fragment.

IsLink

public virtual bool IsLink()= 0;
Returns true if the drag data is a link.

IsReadOnly

public virtual bool IsReadOnly()= 0;
Returns true if this object is read-only.

ResetFileContents

public virtual void ResetFileContents()= 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.

SetFragmentBaseURL

public virtual void SetFragmentBaseURL( const CefString& base_url )= 0;
Set the base URL that the fragment came from.

SetFragmentHtml

public virtual void SetFragmentHtml( const CefString& html )= 0;
Set the text/html fragment that is being dragged.

SetFragmentText

public virtual void SetFragmentText( const CefString& text )= 0;
Set the plain text fragment that is being dragged.

SetLinkMetadata

public virtual void SetLinkMetadata( const CefString& data )= 0;
Set the metadata associated with the link being dragged.

SetLinkTitle

public virtual void SetLinkTitle( const CefString& title )= 0;
Set the title associated with the link being dragged.

SetLinkURL

public virtual void SetLinkURL( const CefString& url )= 0;
Set the link URL that is being dragged.

 Overview   Project   Class   Tree   Index 
CEF3 C++ API Docs - Version 75.1.4+g4210896+chromium-75.0.3770.100
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Chromium Embedded Framework (CEF) Copyright © 2016 Marshall A. Greenblatt