Inheritance diagram for DnDArea:

Public Member Functions
	DnDArea (string name)
	creates a DnDArea widget on the user interface.

Public Attributes
FileFormat::Type	acceptedFileFormat
	accepted file format

string	filepath
	last file path dropped

string	image
	image path for background image

string	droppingImage
	image path for background image when dropping (drawn on top of image)

string	backgroundColour
	background colour: colour string that defines the desired colour.

string	droppingColour
	dropping colour (drawn on top of image/background colour): colour string that defines the desired colour.

function	fileDropped
	callback invoked when a file is dropped

Public Attributes inherited from Widget
string	name
	widget name

string	displayName
	widget display name

string	tooltip
	widget tooltip, default is name

int	x
	x position in pixels

int	y
	y position in pixels

int	width
	widget width in pixels

int	height
	widget height in pixels

table	size
	widget size {width, height}

table	position
	widget position {x,y}

table	bounds
	widget bounding rect {x,y,width,height}

number	alpha
	transparency value between 0.0 and 1.0

bool	enabled
	boolean flag to enable / disable the widget

bool	visible
	boolean flag to toggle widget visibility

bool	interceptsMouseClicks
	boolean flag to toggle mouse handling on widget

bool	showLabel
	show widgets label if any

bool	persistent
	flag to tell if the widget values should be serialized when saving.

function	changed
	callback function used by child widgets to be notified of changes

Detailed Description

DnDArea widget.

creates a DnDArea widget on the user interface. Image properties support Retina @2x variants.

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

Constructor & Destructor Documentation

DnDArea::DnDArea ( string name )

creates a DnDArea widget on the user interface.

Parameters

name	the name to give to the widget

string DnDArea::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

string DnDArea::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