Public Member Functions | Public Attributes

nsIDragService Interface Reference

import "nsIDragService.idl";

List of all members.

Public Member Functions

void invokeDragSession (in nsIDOMNode aDOMNode, in nsISupportsArray aTransferables, in nsIScriptableRegion aRegion, in unsigned long aActionType)
 Starts a modal drag session with an array of transaferables.
void invokeDragSessionWithImage (in nsIDOMNode aDOMNode, in nsISupportsArray aTransferableArray, in nsIScriptableRegion aRegion, in unsigned long aActionType, in nsIDOMNode aImage, in long aImageX, in long aImageY, in nsIDOMDragEvent aDragEvent, in nsIDOMDataTransfer aDataTransfer)
 Starts a modal drag session using an image.
void invokeDragSessionWithSelection (in nsISelection aSelection, in nsISupportsArray aTransferableArray, in unsigned long aActionType, in nsIDOMDragEvent aDragEvent, in nsIDOMDataTransfer aDataTransfer)
 Start a modal drag session using the selection as the drag image.
nsIDragSession getCurrentSession ()
 Returns the current Drag Session.
void startDragSession ()
 Tells the Drag Service to start a drag session.
void endDragSession (in PRBool aDoneDrag)
 Tells the Drag Service to end a drag session.
void fireDragEventAtSource (in unsigned long aMsg)
 Fire a drag event at the source of the drag.
void suppress ()
 Increase/decrease dragging suppress level by one.
void unsuppress ()

Public Attributes

const long DRAGDROP_ACTION_NONE = 0
const long DRAGDROP_ACTION_COPY = 1
const long DRAGDROP_ACTION_MOVE = 2
const long DRAGDROP_ACTION_LINK = 4
const long DRAGDROP_ACTION_UNINITIALIZED = 64

Member Function Documentation

void nsIDragService::endDragSession ( in PRBool  aDoneDrag  ) 

Tells the Drag Service to end a drag session.

This is called when an external drag occurs

If aDoneDrag is true, the drag has finished, otherwise the drag has just left the window.

void nsIDragService::fireDragEventAtSource ( in unsigned long  aMsg  ) 

Fire a drag event at the source of the drag.

nsIDragSession nsIDragService::getCurrentSession (  ) 

Returns the current Drag Session.

void nsIDragService::invokeDragSession ( in nsIDOMNode  aDOMNode,
in nsISupportsArray  aTransferables,
in nsIScriptableRegion  aRegion,
in unsigned long  aActionType 
)

Starts a modal drag session with an array of transaferables.

Parameters:
aTransferables - an array of transferables to be dragged
aRegion - a region containing rectangles for cursor feedback, in window coordinates.
aActionType - specified which of copy/move/link are allowed
void nsIDragService::invokeDragSessionWithImage ( in nsIDOMNode  aDOMNode,
in nsISupportsArray  aTransferableArray,
in nsIScriptableRegion  aRegion,
in unsigned long  aActionType,
in nsIDOMNode  aImage,
in long  aImageX,
in long  aImageY,
in nsIDOMDragEvent  aDragEvent,
in nsIDOMDataTransfer  aDataTransfer 
)

Starts a modal drag session using an image.

The first four arguments are the same as invokeDragSession.

A custom image may be specified using the aImage argument. If this is supplied, the aImageX and aImageY arguments specify the offset within the image where the cursor would be positioned. That is, when the image is drawn, it is offset up and left the amount so that the cursor appears at that location within the image.

If aImage is null, aImageX and aImageY are not used and the image is instead determined from the source node aDOMNode, and the offset calculated so that the initial location for the image appears in the same screen position as where the element is located. The node must be within a document.

Currently, supported images are all DOM nodes. If this is an HTML <image> or <canvas>, the drag image is taken from the image data. If the element is in a document, it will be rendered at its displayed size, othewise, it will be rendered at its real size. For other types of elements, the element is rendered into an offscreen buffer in the same manner as it is currently displayed. The document selection is hidden while drawing.

The aDragEvent must be supplied as the current screen coordinates of the event are needed to calculate the image location.

void nsIDragService::invokeDragSessionWithSelection ( in nsISelection  aSelection,
in nsISupportsArray  aTransferableArray,
in unsigned long  aActionType,
in nsIDOMDragEvent  aDragEvent,
in nsIDOMDataTransfer  aDataTransfer 
)

Start a modal drag session using the selection as the drag image.

The aDragEvent must be supplied as the current screen coordinates of the event are needed to calculate the image location.

void nsIDragService::startDragSession (  ) 

Tells the Drag Service to start a drag session.

This is called when an external drag occurs

void nsIDragService::suppress (  ) 

Increase/decrease dragging suppress level by one.

If level is greater than one, dragging is disabled.

void nsIDragService::unsuppress (  ) 

Member Data Documentation


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