LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XDropTargetDropContext Interface Referencepublished

This interface is implemented by any drop target context object. More...

import"XDropTargetDropContext.idl";

Inheritance diagram for XDropTargetDropContext:
XInterface

Public Member Functions

void acceptDrop ([in] byte dragOperation)
 Accept the Drop. More...
 
void rejectDrop ()
 Reject the drop as a result of examining the available com::sun::star::datatransfer::DataFlavor types received in the XDropTargetListener::dragEnter() method. More...
 
void dropComplete ([in] boolean success)
 Signals that the drop is completed and if it was successful or not. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

This interface is implemented by any drop target context object.

A DropTargetContext is created whenever the logical cursor associated with a Drag and Drop operation moves within the visible geometry of a window associated with a DropTarget.

The drop target context provides the mechanism for a potential receiver of a drop operation to provide the end user with the appropriate drag under feedback and to effect the subsequent data transfer, if appropriate.

Member Function Documentation

void acceptDrop ( [in] byte  dragOperation)

Accept the Drop.

This method should be called from the com::sun::star::datatransfer::dnd::XDropTargetListener::drop() method if the implementation wishes to accept the drop operation with the specified action.

Parameters
dragOperationThe operation accepted by the target.
See also
DNDConstants
DropTargetDragEvent
void dropComplete ( [in] boolean  success)

Signals that the drop is completed and if it was successful or not.

Parameters
successA value of TRUE means the drop completed successfully

A value of FALSE means the drop completed unsuccessfully.

void rejectDrop ( )

Reject the drop as a result of examining the available com::sun::star::datatransfer::DataFlavor types received in the XDropTargetListener::dragEnter() method.


The documentation for this interface was generated from the following file: