A numeric box bound to an existing Element parameter. More...

Inheritance diagram for ParamNumBox:

Public Member Functions
	ParamNumBox (Element elementOrPath, string paramName)
	creates a numeric box bound to an existing Element parameter.

Public Attributes
number	value
	the widget's value (read-only; reflects the bound parameter)

string	align
	text alignment

number	fontSize
	text font size

string	font
	path to a custom TrueType font

number	minimumHorizontalScale
	minimum horizontal font squash before ellipsis

bool	hitTestOnlyOnText
	only react to clicks on the text itself

string	backgroundImage
	path to background image

string	backgroundColour
	background colour

string	textColour
	text colour

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 numeric box bound to an existing Element parameter.

Displays and edits the parameter as a number. It is a Widget (not a NumBox).

Constructor & Destructor Documentation

ParamNumBox::ParamNumBox	(	Element	elementOrPath,
		string	paramName )

creates a numeric box 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)