List of all members | Public Member Functions | Public Attributes
DnDArea Class Reference

DnDArea widget. More...

+ Inheritance diagram for DnDArea:

Public Member Functions

 DnDArea (string name)
 creates a DnDArea widget on the user inteface. More...
 

Public Attributes

FileFormat::Type acceptedFileFormat
 accepted file format
 
number alpha
 transparency value between 0.0 and 1.0
 
string backgroundColour
 background colour: colour string that defines the desired colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
 
table bounds
 widget bounding rect {x,y,width,height}
 
function changed
 callback function used by child widgets to be notified of changes
 
string displayName
 widget display name
 
string droppingColour
 dropping colour (drawn on top of image/background colour): colour string that defines the desired colour. It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format
 
string droppingImage
 image path for background image when dropping (drawn on top of image)
 
bool enabled
 boolean flag to enable / disable the widget
 
function fileDropped
 callback invoked when a file is dropped
 
string filepath
 last file path dropped
 
int height
 widget height in pixels
 
string image
 image path for background image
 
bool interceptsMouseClicks
 boolean flag to toggle mouse handling on widget
 
string name
 widget name
 
bool persistent
 flag to tell if the widget values should be serialized when saving. True by default. Persistent widgets will call their changed function on reload
 
table position
 widget position {x,y}
 
bool showLabel
 show widgets label if any
 
table size
 widget size {width, height}
 
string tooltip
 widget tooltip, default is name
 
bool visible
 boolean flag to toggle widget visibility
 
int width
 widget width in pixels
 
int x
 x position in pixels
 
int y
 y position in pixels
 

Detailed Description

DnDArea widget.

creates a DnDArea widget on the user inteface.

dnd = DnDArea("DnD")
dnd.fileDropped = function(self)
print("fileDropped", self.filepath)
end

Constructor & Destructor Documentation

DnDArea::DnDArea ( string  name)

creates a DnDArea widget on the user inteface.

Parameters
namethe name to give to the widget