Drag[en]gine Script Module DragonScript  1.23
Dragengine.Gui.ClipboardClip Class Reference

Clipboard clip storing data in multiple formats. More...

Inheritance diagram for Dragengine.Gui.ClipboardClip:

Public Member Functions

Array collect (Block ablock)
 Collect data with block receiving object as argument returning true to include. More...
 
Array collectCastable (Block ablock)
 Collect data with block receiving object as argument returning true to include. More...
 
Object find (Block ablock)
 Find data with block receiving object as argument returning true if found. More...
 
Object findCastable (Block ablock)
 Find data with block receiving object as argument returning true if found. More...
 
void forEach (Block ablock)
 Visit data with block receiving object as argument. More...
 
void forEachCastable (Block ablock)
 Visit data with block receiving object as argument. More...
 
Object getAt (int index)
 Data at index. More...
 
int getCount ()
 Count of data. More...
 
Object last ()
 Last data. More...
 
ClipboardClip new (Array data)
 Create clipboard clip with data. More...
 

Detailed Description

Clipboard clip storing data in multiple formats.

Version
1.11

Data is added in the order of the most specific object class to the most generic. Adding String as last entry for non-String objects is not required since the clip consumer has to call toString() on the last data entry if he wants to consume any type of object as string.

Immutable class.

Member Function Documentation

◆ collect()

Array Dragengine.Gui.ClipboardClip.collect ( Block  ablock)

Collect data with block receiving object as argument returning true to include.

Returns Array containing all objects for which block returns true.

◆ collectCastable()

Array Dragengine.Gui.ClipboardClip.collectCastable ( Block  ablock)

Collect data with block receiving object as argument returning true to include.

Returns Array containing all objects for which block returns true. Block is called only for objects castable to block argument.

◆ find()

Object Dragengine.Gui.ClipboardClip.find ( Block  ablock)

Find data with block receiving object as argument returning true if found.

Returns first object for which block returns true or null.

◆ findCastable()

Object Dragengine.Gui.ClipboardClip.findCastable ( Block  ablock)

Find data with block receiving object as argument returning true if found.

Returns first object for which block returns true or null. Block is called only for objects castable to block argument.

◆ forEach()

void Dragengine.Gui.ClipboardClip.forEach ( Block  ablock)

Visit data with block receiving object as argument.

◆ forEachCastable()

void Dragengine.Gui.ClipboardClip.forEachCastable ( Block  ablock)

Visit data with block receiving object as argument.

Block is only called for objects castable to block argument.

◆ getAt()

Object Dragengine.Gui.ClipboardClip.getAt ( int  index)

Data at index.

◆ getCount()

int Dragengine.Gui.ClipboardClip.getCount ( )

Count of data.

◆ last()

Object Dragengine.Gui.ClipboardClip.last ( )

Last data.

◆ new()

ClipboardClip Dragengine.Gui.ClipboardClip.new ( Array  data)

Create clipboard clip with data.

Exceptions
ENullPointerdata or entry in data is null.
EInvalidParamdata is empty.

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