nsIDragSession

IID:CBA22C53-FCCE-11d2-96D4-0060B0FB9956
Inherits From:nsISupports

This interface is implemented by the following components:


Properties

PRBool canDrop

Set the current state of the drag whether it can be dropped or not. usually the target "frame" sets this so the native system can render the correct feedback

PRUint32 dragAction

Sets the action (copy, move, link, et.c) for the current drag

readonly PRUint32 numDropItems

Get the number items that were dropped

readonly nsIDOMDocument sourceDocument

The document where the drag was started, which will be null if the drag originated outside the application. Useful for determining if a drop originated in the same document.

readonly nsIDOMNode sourceNode

The dom node that was originally dragged to start the session, which will be null if the drag originated outside the application.

nsSize targetSize

Sets the current width and height if the drag target area. It will contain the current size of the Frame that the drag is currently in


Methods

void getData ( nsITransferable transferable , PRUint32 itemIndex ) PRBool isDataFlavorSupported ( char* dataFlavor )

void getData ( nsITransferable transferable , PRUint32 itemIndex )

Get data from a Drag&Drop.; Can be called while the drag is in process or after the drop has completed.

Arguments:
transferable: the transferable for the data to be put into
itemIndex: which of multiple drag items, zero-based

PRBool isDataFlavorSupported ( char* dataFlavor )

Check to set if ant of the native data on the clipboard matches this data flavor

Arguments:
dataFlavor

References

This interface is passed as an argument to the following methods:

nsIClipboardDragDropHooks.allowDrop

This interface is returned from the following methods:

nsIDragService.getCurrentSession

Reference documentation is generated from Mozilla's source.

Add a note User Contributed Notes
No comments available

Copyright © 1999 - 2005 XULPlanet.com