Slider Class Reference

Horizontal or vertical slider widget. More...

Inheritance diagram for Slider:

Public Member Functions
	Slider (string name, number def, number min, number max, bool integer, bool vertical)
	creates a slider widget on the user interface.
void	setValue (number value, bool callChangedCallback=true)
void	setRange (number min, number max)
void	setStripImage (string imagePath, int numImages)

Public Attributes
number	value
	the widget's value
number	min
	the widget's minimum value
number	max
	the widget's maximum value
number	default
	the widget's default value
int	paramId
	parameter id
string	backgroundColour
	background colour.
string	thumbColour
	thumb colour.
string	trackColour
	track colour.
string	fillColour
	fill colour.
string	backgroundImage
	path to background image
string	handleImage
	path to handle image
bool	showPopupDisplay
	show/hide the value popup display (if any)
string	displayText
	custom text to display in place of the standard value display.
Public Attributes inherited from ParamWidget
Mapper::Type	mapper
	Mapper type, default is Mapper.Linear.
Unit::Type	unit
	Unit type, default is Unit.Generic.
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

Horizontal or vertical slider widget.

creates a slider widget on the user interface.

s = Slider("slider", 0.5, 0.0, 1.0, false, false)
s.changed = function(self)
  print("slider changed", self.value)
end

Constructor & Destructor Documentation

Slider()

Slider::Slider	(	string	name,
		number	def,
		number	min,
		number	max,
		bool	integer,
		bool	vertical )

creates a slider widget on the user interface.

Parameters

name	the name to give to the widget
def	default and initial value
min	minimum value
max	maximum value
integer	optional default is false
vertical	optional default is false

Member Function Documentation

setRange()

void Slider::setRange	(	number	min,
		number	max )

Parameters

min	minimum value
max	maximum value

setStripImage()

void Slider::setStripImage	(	string	imagePath,
		int	numImages )

Parameters

imagePath	path to knob strip image. Supports Retina @2x variants.
numImages	number of images in strip

setValue()

void Slider::setValue	(	number	value,
		bool	callChangedCallback = true )

Parameters

value	the new widget's value
callChangedCallback	call the changed callback function if true

Member Data Documentation

backgroundColour

string Slider::backgroundColour

background colour.

It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format

displayText

string Slider::displayText

custom text to display in place of the standard value display.

To revert to the standard behaviour, leave it empty.

fillColour

string Slider::fillColour

fill colour.

It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format

thumbColour

string Slider::thumbColour

thumb colour.

It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format

trackColour

string Slider::trackColour

track colour.

It can be either a named colour like "blue" or "red" or an hexadecimal string in RGB ("#FF00CC") or ARGB ("#3C00FECD") format