nsIDOMUserDataHandler

dom/interfaces/core/nsIDOMUserDataHandler.idlScriptable

The callback function for the setUserData method.

1.0

Introduced

Gecko 1.5

Inherits from: nsISupports Last changed in Gecko 1.9 (Firefox 3)

Method overview

void handle(in unsigned short operation, in DOMString key, in nsIVariant data, in nsIDOMNode src, in nsIDOMNode dst);

Constant	Value	Description
`NODE_CLONED`	`1`	The node was cloned.
`NODE_IMPORTED`	`2`	The node was cloned into a new document.
`NODE_DELETED`	`3`	Unimplemented
`NODE_RENAMED`	`4`	Unimplemented
`NODE_ADOPTED`	`5`	The node was adopted into a new document.

This method is a callback which will be called if a node with user data is being cloned, imported or adopted.

void handle(
  in unsigned short operation,
  in DOMString key,
  in nsIVariant data,
  in nsIDOMNode src,
  in nsIDOMNode dst
);

operation: One of the NODE_* operation type constants from the above table.
key: The key that was used to set the user data.
data: The data that was set on the original node.
src: The original node.
dst: The new node, for clone and import operations.