ParamSlider Class Reference

A fader bound to an existing Element parameter. More...

Inheritance diagram for ParamSlider:

Public Member Functions
	ParamSlider (Element elementOrPath, string paramName)
	creates a slider bound to an existing Element parameter.
void	setRange (number min, number max)
	override the range inherited from the parameter.
void	setStripImage (string imagePath, int numImages)

Public Attributes
number	value
	the widget's value (read-only; reflects the bound parameter)
Unit::Type	unit
	unit override, default is taken from the parameter
bool	horizontal
	true for a horizontal fader, false for vertical
bool	showPopupDisplay
	show/hide the value popup display (if any)
string	backgroundColour
	background colour (named colour or RGB/ARGB hex string)
string	thumbColour
	thumb colour (named colour or RGB/ARGB hex string)
string	fillColour
	fill colour (named colour or RGB/ARGB hex string)
string	trackColour
	track colour (named colour or RGB/ARGB hex string)
string	backgroundImage
	path to background image
string	handleImage
	path to handle image
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

A fader bound to an existing Element parameter.

Like ParamKnob but rendered as a slider. It is a Widget (not a Slider).

Constructor & Destructor Documentation

ParamSlider()

ParamSlider::ParamSlider	(	Element	elementOrPath,
		string	paramName )

creates a slider bound to an existing Element parameter.

Parameters

elementOrPath	an Element reference, or a path string identifying one
paramName	the parameter name (as used by setParameter)

Member Function Documentation

setRange()

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

override the range inherited from the parameter.

Parameters

min	minimum value
max	maximum value

setStripImage()

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

Parameters

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