interface XDragSourceContext in module com::sun::star::datatransfer::dnd::

(Global Index)

Syntax

interface XDragSourceContext : com::sun::star::uno::XInterface ;

Description

The drag source context class is responsible for managing the initiator side of the Drag and Drop protocol.

In particular, it is responsible for managing event notifications to the DragSourceListener and providing the Transferable state to enable the data transfer.

An instance of this class is created as a result of the method XDragSource::startDrag() being successfully invoked. This instance is responsible for tracking the state of the operation on behalf of the drag source and dispatching state changes to the drag source listener.

See also

XDragSourceContext

See also

XDragSourceListener

Method Summary

getCurrentCursor Get the identifier of the currently used cursor.

setCursor This method sets the current drag cursor.

setImage This method sets the current drag image.

transferablesFlavorsChanged This method notifies the context that the DataFlavor types of the transferable object have changed.

Method Details



getCurrentCursor

Syntax

long getCurrentCursor ();

Description

Get the identifier of the currently used cursor.

Returns

The currently selected drag cursor.

setCursor

Syntax

oneway void setCursor (
long cursorId );

Description

This method sets the current drag cursor.

This method should only be called to set another cursor than the default one for drag action currently selected by the user.

Invalid cursor identifiers will be ignored.

Parameter cursorId

The identifier the drag source returned when registering the cursor.

setImage

Syntax

oneway void setImage (
long imageId );

Description

This method sets the current drag image.

Parameter dragImage

The identifier the drag source returned when registering the image (0 = none). Invalid identifier will be ignored.

transferablesFlavorsChanged

Syntax

oneway void transferablesFlavorsChanged ();

Description

This method notifies the context that the DataFlavor types of the transferable object have changed.

See also

XTransferable
Top of Page