Module xPatternSelection
Static methods for working with pattern-selections .
Pattern-selection
{
start_line, -- Start pattern line index
start_track, -- Start track index
start_column, -- Start column index within start_track
end_line, -- End pattern line index
end_track, -- End track index
end_column -- End column index within end_track
}
Functions
| get_pattern_track (seq_idx, trk_idx) | [Static] Retrieve selection spanning an entire pattern-track |
| get_pattern_column (seq_idx, trk_idx, col_idx) | [Static] Get a selection spanning the provided column |
| get_pattern_if_single_track () | [Static] Get existing pattern selection when valid for a single track |
| get_column_in_track (seq_idx, trk_idx, col_idx) | [Static] Get selection spanning an entire column in a pattern-track |
| get_group_in_pattern (seq_idx, trk_idx) | [Static] Get selection spanning an entire group in a pattern-track |
| is_single_column (patt_sel) | [Static] Test if selection is limited to a single column |
| is_single_track (patt_sel) | [Static] Test if selection is limited to a single track |
| includes_note_columns (patt_sel) | [Static] Test if selection includes note columns |
| spans_entire_line (patt_sel, number_of_columns) | [Static] Test if selection spans entire line |
| within_bounds (patt_sel, cursor) | check if a cursor is situated somewhere within a pattern-selection |
Functions
- get_pattern_track (seq_idx, trk_idx)
-
[Static] Retrieve selection spanning an entire pattern-track
Parameters:
- seq_idx (int)
- trk_idx (int)
Returns:
- table (pattern-selection) or bool (false, on error)
- string (error message when failed)
- get_pattern_column (seq_idx, trk_idx, col_idx)
-
[Static] Get a selection spanning the provided column
Parameters:
- seq_idx (int)
- trk_idx (int)
- col_idx (int)
Returns:
- table (pattern-selection) or bool (false, on error)
- string (error message when failed)
- get_pattern_if_single_track ()
-
[Static] Get existing pattern selection when valid for a single track
Returns:
- table (pattern-selection) or bool (false, on error)
- string (error message when failed)
- get_column_in_track (seq_idx, trk_idx, col_idx)
-
[Static] Get selection spanning an entire column in a pattern-track
Parameters:
- seq_idx (int)
- trk_idx (int)
- col_idx (int)
Returns:
- table (pattern-selection) or bool (false, on error)
- string (error message when failed)
- get_group_in_pattern (seq_idx, trk_idx)
-
[Static] Get selection spanning an entire group in a pattern-track
Parameters:
- seq_idx (int)
- trk_idx (int)
Returns:
- table (pattern-selection) or bool (false, on error)
- string (error message when failed)
- is_single_column (patt_sel)
-
[Static] Test if selection is limited to a single column
Parameters:
- patt_sel (table )
Returns:
-
bool
- is_single_track (patt_sel)
-
[Static] Test if selection is limited to a single track
Parameters:
- patt_sel (table )
Returns:
-
bool
- includes_note_columns (patt_sel)
-
[Static] Test if selection includes note columns
Parameters:
- patt_sel (table )
Returns:
-
bool
- spans_entire_line (patt_sel, number_of_columns)
-
[Static] Test if selection spans entire line
Parameters:
- patt_sel (table)
- number_of_columns (number)
Returns:
-
bool
- within_bounds (patt_sel, cursor)
-
check if a cursor is situated somewhere within a pattern-selection
Parameters:
- patt_sel
- cursor
Returns:
-
boolean