Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: datatransfer :: dnd ::

interface XDragSourceContext
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, XDragSourceListener

Methods' 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 ::com::sun::star::datatransfer::DataFlavor types of the transferable object have changed.  
Methods' Details
getCurrentCursor
long
getCurrentCursor();

Description
Get the identifier of the currently used cursor.
Returns
The currently selected drag cursor.
setCursor
[oneway] void
setCursor( [in] 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
[oneway] void
setImage( [in] 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
[oneway] void
transferablesFlavorsChanged();

Description
This method notifies the context that the ::com::sun::star::datatransfer::DataFlavor types of the transferable object have changed.
See also
::com::sun::star::datatransfer::XTransferable
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.