uvi-script
Musical event scripting with Lua

Image widget. More...

Inheritance diagram for Image:
Widget

Public Member Functions

 Image (string imagePath)
 creates an Image widget on the user interface.
 

Public Attributes

RectanglePlacement::Type rectanglePlacement
 image alignement
 
string image
 image path for background image
 
string overImage
 image path for background image with mouse over
 
- Public Attributes inherited from Widget
string name
 widget name, given at construction (read-only)
 
string displayName
 widget display name
 
string displayText
 custom text to display in place of the standard value display, on widgets that show one.
 
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
 
int w
 alias of width
 
int h
 alias of height
 
table size
 widget size {width, height}
 
table position
 widget position {x,y}
 
table pos
 alias of position
 
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

Image widget.

creates an Image widget on the user interface. Supports Retina @2x variants.

img = Image("resources/image.png")
img.pos = {100, 100}
img.alpha = 0.5
Image(string imagePath)
creates an Image widget on the user interface.
table pos
alias of position
Definition ui.cpp:987

Constructor & Destructor Documentation

◆ Image()

Image::Image ( string imagePath)

creates an Image widget on the user interface.

Parameters
imagePaththe name to give to the widget