File Duplex/UISlider.lua

Functions

UISlider:__init (display) Initialize the UISlider class
UISlider:_determine_index_by_pos (column, row) Determine index by position, depends on orientation
UISlider:_invoke_handler () Trigger the external handler method
UISlider:add_listeners () Add event listeners (press, release, change)
UISlider:do_change (msg) A value was changed (slider, dial) set index + precise value within the index
UISlider:do_press (msg) A button was pressed
UISlider:do_release (msg) A button was released
UISlider:draw () Update the UIComponent canvas
UISlider:force_update () Force-update controls that are handling their internal state by themselves
UISlider:get_orientation () Get the orientation
UISlider:remove_listeners () Remove previously attached event listeners
UISlider:set_dimmed (bool) Display the slider as "dimmed" (use alternative palette)
UISlider:set_index (idx, skip_event) Set index (will also update the value)
UISlider:set_orientation (value) Set the slider orientation (only relevant when assigned to buttons)
UISlider:set_size (size) Set the size (will change the canvas too)
UISlider:set_value (val, skip_event) Set the value (will also update the index)
UISlider:test (group_name, column, row) Expanded UIComponent test: look for group name, event handlers before proceeding with the normal UIComponent test


Functions

UISlider:__init (display)
Initialize the UISlider class

Parameters:

  • display: (Duplex.Display)
UISlider:_determine_index_by_pos (column, row)
Determine index by position, depends on orientation

Parameters:

  • column: (Number)
  • row: (Number)
UISlider:_invoke_handler ()
Trigger the external handler method

Return value:

    true when message was handled, false when not
UISlider:add_listeners ()
Add event listeners (press, release, change)
UISlider:do_change (msg)
A value was changed (slider, dial) set index + precise value within the index

Parameters:

  • msg: (Duplex.Message)

Return value:

    boolean, true when message was handled
UISlider:do_press (msg)
A button was pressed

Parameters:

  • msg: (Duplex.Message)

Return value:

    boolean, true when message was handled
UISlider:do_release (msg)
A button was released

Parameters:

  • msg: (Duplex.Message)

Return value:

    boolean, true when message was handled
UISlider:draw ()
Update the UIComponent canvas
UISlider:force_update ()
Force-update controls that are handling their internal state by themselves
UISlider:get_orientation ()
Get the orientation

Return value:

    (Enum) either VERTICAL or HORIZONTAL
UISlider:remove_listeners ()
Remove previously attached event listeners

See also:

UISlider:set_dimmed (bool)
Display the slider as "dimmed" (use alternative palette)

Parameters:

  • bool: (Boolean) true for dimmed state, false for normal state
UISlider:set_index (idx, skip_event)
Set index (will also update the value)

Parameters:

  • idx: (integer)
  • skip_event: (boolean) skip event handler

Return value:

    (boolean), false when rejected by handler
UISlider:set_orientation (value)
Set the slider orientation (only relevant when assigned to buttons)

Parameters:

  • value: (Enum) either VERTICAL or HORIZONTAL
UISlider:set_size (size)
Set the size (will change the canvas too)

Parameters:

  • size: (Number)
UISlider:set_value (val, skip_event)
Set the value (will also update the index)

Parameters:

  • val: (float), a number between 0 and .ceiling
  • skip_event: (boolean) skip event handler

Return value:

    (boolean), false when rejected by handler
UISlider:test (group_name, column, row)
Expanded UIComponent test: look for group name, event handlers before proceeding with the normal UIComponent test

Parameters:

  • group_name: (String)
  • column: (Number)
  • row: (Number)

Return value:

    boolean, false when criteria is not met

Valid XHTML 1.0!