VirtualBox Main API
Public Member Functions | List of all members
IDnDSource Interface Reference

Abstract interface for handling drag'n drop sources. More...

Inheritance diagram for IDnDSource:
IDnDBase IGuestDnDSource

Public Member Functions

void dragIsPending (in unsigned long screenId, out wstring[] formats, out DnDAction[] allowedActions, [retval] out DnDAction defaultAction)
 Ask the source if there is any drag and drop operation pending.
 
void drop (in wstring format, in DnDAction action, [retval] out IProgress progress)
 Informs the source that a drop event occurred for a pending drag and drop operation.
 
void receiveData ([retval] out octet[] data)
 Receive the data of a previously drag and drop event from the source.
 
- Public Member Functions inherited from IDnDBase
void isFormatSupported (in wstring format, [retval] out boolean supported)
 Checks if a specific drag'n drop MIME / Content-type format is supported.
 
void addFormats (in wstring[] formats)
 Adds MIME / Content-type formats to the supported formats.
 
void removeFormats (in wstring[] formats)
 Removes MIME / Content-type formats from the supported formats.
 

Additional Inherited Members

- Public Attributes inherited from IDnDBase
readonly attribute wstring[] formats
 Returns all supported drag'n drop formats.
 

Detailed Description

Abstract interface for handling drag'n drop sources.

Interface ID:
{D23A9CA3-42DA-C94B-8AEC-21968E08355D}

Member Function Documentation

◆ dragIsPending()

void IDnDSource::dragIsPending ( in unsigned long  screenId,
out wstring[]  formats,
out DnDAction[]  allowedActions,
[retval] out DnDAction  defaultAction 
)

Ask the source if there is any drag and drop operation pending.

If no drag and drop operation is pending currently, DnDAction_Ignore is returned.

Parameters
screenIdThe screen ID where the drag and drop event occurred.
formatsOn return the supported mime types.
allowedActionsOn return the actions which are allowed.
defaultActionOn return the default action to use.
Expected result codes:
VBOX_E_VM_ERRORVMM device is not available.

◆ drop()

void IDnDSource::drop ( in wstring  format,
in DnDAction  action,
[retval] out IProgress  progress 
)

Informs the source that a drop event occurred for a pending drag and drop operation.

Parameters
formatThe mime type the data must be in.
actionThe action to use.
progressProgress object to track the operation completion.
Expected result codes:
VBOX_E_VM_ERRORVMM device is not available.

◆ receiveData()

void IDnDSource::receiveData ( [retval] out octet[]  data)

Receive the data of a previously drag and drop event from the source.

Parameters
dataThe actual data.
Expected result codes:
VBOX_E_VM_ERRORVMM device is not available.