File Duplex/UIButtonStrip.lua
Functions
UIButtonStrip:__init (display) | Initialize the UIButtonStrip class |
UIButtonStrip:_determine_index_by_pos (column, row) | Determine the control's index by it's position |
UIButtonStrip:_in_range (idx) | Check if provided index is within the current range |
UIButtonStrip:_toggle_blink () | Toggle the control's blinking behaviour |
UIButtonStrip:add_listeners () | Add event listeners (press, release, hold) |
UIButtonStrip:do_hold (msg) | User held a button |
UIButtonStrip:do_press (msg) | User pressed a button |
UIButtonStrip:do_release (msg) | User released a button |
UIButtonStrip:draw () | Update the control's visual appearance |
UIButtonStrip:get_index () | Get the current index |
UIButtonStrip:get_orientation () | Get the orientation |
UIButtonStrip:get_range () | Get the current range |
UIButtonStrip:get_steps () | Get the number of steps |
UIButtonStrip:pause_blink () | Pause blinking behaviour |
UIButtonStrip:remove_listeners () | Remove previously attached event listeners |
UIButtonStrip:set_index (idx, skip_event) | Set the current index |
UIButtonStrip:set_orientation (value) | Set the control's orientation |
UIButtonStrip:set_range (idx1, idx2, skip_event) | Set the current range (swap values if needed, first should be lowest) |
UIButtonStrip:set_size (size) | (Override UIComponent with this method) |
UIButtonStrip:set_steps (steps) | Set the number of steps |
UIButtonStrip:start_blink (idx) | Start blinking behaviour for one of the buttons |
UIButtonStrip:stop_blink () | Stop blinking behaviour |
UIButtonStrip:test (column, row) | Expanded UIComponent test. |
Functions
- UIButtonStrip:__init (display)
-
Initialize the UIButtonStrip class
Parameters:
-
display
: (Duplex.Display)
-
- UIButtonStrip:_determine_index_by_pos (column, row)
-
Determine the control's index by it's position
Parameters:
-
column
: (Number) -
row
: (Number)
Return value:
- Number
-
- UIButtonStrip:_in_range (idx)
-
Check if provided index is within the current range
Parameters:
-
idx
:
Return value:
- Boolean
-
- UIButtonStrip:_toggle_blink ()
- Toggle the control's blinking behaviour
- UIButtonStrip:add_listeners ()
- Add event listeners (press, release, hold)
- UIButtonStrip:do_hold (msg)
-
User held a button
Parameters:
-
msg
: (Duplex.Message)
Return value:
- true (hold message are always handled)
-
- UIButtonStrip:do_press (msg)
-
User pressed a button
Parameters:
-
msg
: (Duplex.Message)
Return value:
- boolean, true when message was handled
-
- UIButtonStrip:do_release (msg)
-
User released a button
Parameters:
-
msg
: (Duplex.Message)
Return value:
- boolean, true when message was handled
-
- UIButtonStrip:draw ()
- Update the control's visual appearance
- UIButtonStrip:get_index ()
-
Get the current index
Return value:
- Number
- UIButtonStrip:get_orientation ()
-
Get the orientation
Return value:
- (Enum) either VERTICAL or HORIZONTAL
- UIButtonStrip:get_range ()
-
Get the current range
Return value:
- Table containing upper/lower index
- UIButtonStrip:get_steps ()
-
Get the number of steps
Return value:
- Number
- UIButtonStrip:pause_blink ()
- Pause blinking behaviour
- UIButtonStrip:remove_listeners ()
-
Remove previously attached event listeners
See also:
- UIButtonStrip:set_index (idx, skip_event)
-
Set the current index
Parameters:
-
idx
: (Number) the index to set -
skip_event
: (Boolean) if true, invoke the event handler
-
- UIButtonStrip:set_orientation (value)
-
Set the control's orientation
Parameters:
-
value
: (Enum) either VERTICAL or HORIZONTAL
-
- UIButtonStrip:set_range (idx1, idx2, skip_event)
-
Set the current range (swap values if needed, first should be lowest)
Parameters:
-
idx1
: (Number) range 1 -
idx2
: (Number) range 2 -
skip_event
: (Boolean) if true, invoke the event handler
-
- UIButtonStrip:set_size (size)
-
(Override UIComponent with this method)
Parameters:
-
size
: (Number) the size in units
-
- UIButtonStrip:set_steps (steps)
-
Set the number of steps
Parameters:
-
steps
: (Number)
-
- UIButtonStrip:start_blink (idx)
-
Start blinking behaviour for one of the buttons
Parameters:
-
idx
: (Number) the button index
-
- UIButtonStrip:stop_blink ()
- Stop blinking behaviour
- UIButtonStrip:test (column, row)
-
Expanded UIComponent test. Check if we have no events assigned at all, before proceeding with the standard UIComponent test
Parameters:
-
column
: (Number) -
row
: (Number)
Return value:
- Boolean
-