org.virtualbox_5_0
Class IDnDTarget

java.lang.Object
  extended by org.virtualbox_5_0.IUnknown
      extended by org.virtualbox_5_0.IDnDBase
          extended by org.virtualbox_5_0.IDnDTarget
Direct Known Subclasses:
IGuestDnDTarget

public class IDnDTarget
extends IDnDBase

Abstract interface for handling drag'n drop targets. Interface ID: {FF5BEFC3-4BA3-7903-2AA4-43988BA11554}


Field Summary
 
Fields inherited from class org.virtualbox_5_0.IUnknown
obj, port
 
Constructor Summary
IDnDTarget(java.lang.String wrapped, org.virtualbox_5_0.jaxws.VboxPortType port)
           
 
Method Summary
 java.lang.Boolean cancel()
          Requests cancelling the current operation.
 DnDAction drop(java.lang.Long screenId, java.lang.Long x, java.lang.Long y, DnDAction defaultAction, java.util.List<DnDAction> allowedActions, java.util.List<java.lang.String> formats, Holder<java.lang.String> format)
          Informs the target about a drop event.
 DnDAction enter(java.lang.Long screenId, java.lang.Long y, java.lang.Long x, DnDAction defaultAction, java.util.List<DnDAction> allowedActions, java.util.List<java.lang.String> formats)
          Informs the target about a drag and drop enter event.
 void leave(java.lang.Long screenId)
          Informs the target about a drag and drop leave event.
 DnDAction move(java.lang.Long screenId, java.lang.Long x, java.lang.Long y, DnDAction defaultAction, java.util.List<DnDAction> allowedActions, java.util.List<java.lang.String> formats)
          Informs the target about a drag and drop move event.
static IDnDTarget queryInterface(IUnknown obj)
           
 IProgress sendData(java.lang.Long screenId, java.lang.String format, byte[] data)
          Initiates sending data to the target.
 
Methods inherited from class org.virtualbox_5_0.IDnDBase
addFormats, getFormats, getProtocolVersion, isFormatSupported, removeFormats
 
Methods inherited from class org.virtualbox_5_0.IUnknown
getRemoteWSPort, getWrapped, releaseRemote
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IDnDTarget

public IDnDTarget(java.lang.String wrapped,
                  org.virtualbox_5_0.jaxws.VboxPortType port)
Method Detail

queryInterface

public static IDnDTarget queryInterface(IUnknown obj)

enter

public DnDAction enter(java.lang.Long screenId,
                       java.lang.Long y,
                       java.lang.Long x,
                       DnDAction defaultAction,
                       java.util.List<DnDAction> allowedActions,
                       java.util.List<java.lang.String> formats)
Informs the target about a drag and drop enter event.

Parameters:
screenId - The screen ID where the drag and drop event occurred.
y - Y-position of the event.
x - X-position of the event.
defaultAction - The default action to use.
allowedActions - The actions which are allowed.
formats - The supported MIME types.
Returns:
The resulting action of this event. Expected result codes:
@link ::VBOX_E_VM_ERROR VBOX_E_VM_ERRORVMM device is not available.

move

public DnDAction move(java.lang.Long screenId,
                      java.lang.Long x,
                      java.lang.Long y,
                      DnDAction defaultAction,
                      java.util.List<DnDAction> allowedActions,
                      java.util.List<java.lang.String> formats)
Informs the target about a drag and drop move event.

Parameters:
screenId - The screen ID where the drag and drop event occurred.
x - X-position of the event.
y - Y-position of the event.
defaultAction - The default action to use.
allowedActions - The actions which are allowed.
formats - The supported MIME types.
Returns:
The resulting action of this event. Expected result codes:
@link ::VBOX_E_VM_ERROR VBOX_E_VM_ERRORVMM device is not available.

leave

public void leave(java.lang.Long screenId)
Informs the target about a drag and drop leave event.

Parameters:
screenId - The screen ID where the drag and drop event occurred. Expected result codes:
@link ::VBOX_E_VM_ERROR VBOX_E_VM_ERRORVMM device is not available.

drop

public DnDAction drop(java.lang.Long screenId,
                      java.lang.Long x,
                      java.lang.Long y,
                      DnDAction defaultAction,
                      java.util.List<DnDAction> allowedActions,
                      java.util.List<java.lang.String> formats,
                      Holder<java.lang.String> format)
Informs the target about a drop event.

Parameters:
screenId - The screen ID where the Drag and Drop event occurred.
x - X-position of the event.
y - Y-position of the event.
defaultAction - The default action to use.
allowedActions - The actions which are allowed.
formats - The supported MIME types.
format - The resulting format of this event.
Returns:
The resulting action of this event. Expected result codes:
@link ::VBOX_E_VM_ERROR VBOX_E_VM_ERRORVMM device is not available.

sendData

public IProgress sendData(java.lang.Long screenId,
                          java.lang.String format,
                          byte[] data)
Initiates sending data to the target.

Parameters:
screenId - The screen ID where the drag and drop event occurred.
format - The MIME type the data is in.
data - The actual data.
Returns:
Progress object to track the operation completion. Expected result codes:
@link ::VBOX_E_VM_ERROR VBOX_E_VM_ERRORVMM device is not available.

cancel

public java.lang.Boolean cancel()
Requests cancelling the current operation. The target can veto the request in case the operation is not cancelable at the moment.

Returns:
Whether the target has vetoed cancelling the operation. Expected result codes:
@link ::VBOX_E_VM_ERROR VBOX_E_VM_ERRORVMM device is not available.