Back to index

lightning-sunbird  0.9+nobinonly
Public Member Functions | Public Attributes
nsIDragSession Interface Reference

import "nsIDragSession.idl";

Inheritance diagram for nsIDragSession:
Inheritance graph
[legend]
Collaboration diagram for nsIDragSession:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void getData (in nsITransferable aTransferable, in unsigned long aItemIndex)
 Get data from a Drag&Drop.
boolean isDataFlavorSupported (in string aDataFlavor)
 Check to set if ant of the native data on the clipboard matches this data flavor.

Public Attributes

attribute boolean canDrop
 Set the current state of the drag whether it can be dropped or not.
attribute unsigned long dragAction
 Sets the action (copy, move, link, et.c) for the current drag.
attribute nsSize targetSize
 Sets the current width and height if the drag target area.
readonly attribute unsigned long numDropItems
 Get the number items that were dropped.
readonly attribute nsIDOMDocument sourceDocument
 The document where the drag was started, which will be null if the drag originated outside the application.
readonly attribute nsIDOMNode sourceNode
 The dom node that was originally dragged to start the session, which will be null if the drag originated outside the application.

Detailed Description

Definition at line 56 of file nsIDragSession.idl.


Member Function Documentation

void nsIDragSession::getData ( in nsITransferable  aTransferable,
in unsigned long  aItemIndex 
)

Get data from a Drag&Drop.

Can be called while the drag is in process or after the drop has completed.

Parameters:
aTransferablethe transferable for the data to be put into
aItemIndexwhich of multiple drag items, zero-based

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

Returns:
NS_OK if if the data flavor is supported and, NS_ERROR_FAILURE is it is not

Member Data Documentation

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

Definition at line 62 of file nsIDragSession.idl.

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

Definition at line 67 of file nsIDragSession.idl.

Get the number items that were dropped.

Definition at line 78 of file nsIDragSession.idl.

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.

Definition at line 85 of file nsIDragSession.idl.

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

Definition at line 91 of file nsIDragSession.idl.

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

Definition at line 73 of file nsIDragSession.idl.


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