Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The function isType should generally be used by all elements to check the type of a drop operation. It automatically causes further data reads from the object to return information from a matching base object. This functionality is also utilized by the framework, i.e. a custom drag with a supported base data item available in the chain can be used with an out of the box framework element. The currently active data is called top level data. Special cases requiring a rewind of the inheritance chain can use the resetType function.

When drag objects are set using the setData function, here is the expected format of the LUA table used to define the drag object:

...

type   (string)   [optional]
The type applied to the created base dragdata

Return values

(dragdata)
Returns a dragdata object representing the created base data object.

...

Return values

(databasenode)
databasenode object

getDescription

Code Block
languagelua
function getDescription()

...

dragrecord   (table)   
See dragdata description for details on the drag record structure.

...

node   (databasenode)   
databasenode object

setDescription

Code Block
languagelua
function setDescription(description)

...

class   (string)   
The name of the windowclass resource used as a target of the shortcut

...