Module xCursorPos
Describes the position of the edit cursor within the project timeline.
Functions
| __init (...) | [Constructor] accepts a single argument for initializing the class |
| resolve () | [Class] Resolve the position, perform some validation steps |
| get_column () | [Class] Get the note/effect-column from the stored position |
| select () | [Class] Attempt to move the pattern-cursor to the stored position |
| handle_key (key) | [Static] Emulate basic pattern navigation when using arrow keys, tab etc.. |
Fields
| self.sequence | number, sequence index of pattern |
| self.track | number, track index |
| self.line | number, line index (NB: can contain fractional part) |
| self.column | number, note/effect column index (across visible columns) |
Functions
- __init (...)
-
[Constructor] accepts a single argument for initializing the class
Parameters:
- ... TRACE("xCursorPos __init(...)")
- resolve ()
-
[Class] Resolve the position, perform some validation steps
Returns:
- number (pattern index or nil if failed)
- renoise.Pattern or string (if failed)
- renoise.Track
- renoise.PatternTrack
- renoise.PatternLine
- get_column ()
-
[Class] Get the note/effect-column from the stored position
Returns:
- renoise.NoteColumn/EffectColumn or nil if invalid/out of bounds
- string, [error message (string)]
- select ()
-
[Class] Attempt to move the pattern-cursor to the stored position
Returns:
-
string, [error message (string)]
- handle_key (key)
-
[Static] Emulate basic pattern navigation when using arrow keys, tab etc..
Parameters:
- key , table (see Renoise.Viewbuilder.API docs)
Returns:
-
boolean, true when key was handled