Skip to content

Shell

[BShell]{#BShell data-4search="ui/b/shell.tsx:BShell;section"}

User interface shell for editing and display of a Ase.Project. Instance access is provided via the global Shell constant.

Properties:

project : The Ase.Project shown by the Shell, set by reset().

BShell class

class [BShell]{#BShell data-4search="ui/b/shell.tsx:BShell;class"} : …

[**`on_resize`**]{#on_resize data-4search="ui/b/shell.tsx:on_resize;func"}  `(`*callback*`)`
:   Call `callback` on window resizes, until the returned function is called or the Shell tree is re-mounted

[**`current_track`**]{#current_track data-4search="ui/b/shell.tsx:current_track;func"} `()`
:   Access current_track (reactive)

[**`reset`**]{#reset data-4search="ui/b/shell.tsx:reset;func"}  `(`*project, current_track*`)`
:   Reset Shell for a new project (Shell is a persistent singleton)

[**`setup`**]{#setup data-4search="ui/b/shell.tsx:setup;func"}  `(`*shell_element*`)`
:   Called when ShellTemplate is instantiated

[**`piano_current`**]{#piano_current data-4search="ui/b/shell.tsx:piano_current;func"}  `(`*clip, beatfn*`)`
:   Helper to refer to the current piano roll clip and beat

[**`show_about_dialog`**]{#show_about_dialog data-4search="ui/b/shell.tsx:show_about_dialog;func"}  `(`*onoff*`)`
:   Show/hide about dialog

[**`piano_roll`**]{#piano_roll data-4search="ui/b/shell.tsx:piano_roll;func"} `()`
:   Access PianoRoll component

[**`show_spinner`**]{#show_spinner data-4search="ui/b/shell.tsx:show_spinner;func"} `()`
:   Show spinner to indicate "busy" state (increment reason)

[**`hide_spinner`**]{#hide_spinner data-4search="ui/b/shell.tsx:hide_spinner;func"} `()`
:   Hide spinner to indicate "busy" state (decrement reason)

[**`show_notice`**]{#show_notice data-4search="ui/b/shell.tsx:show_notice;func"}  `(`*text, timeout*`)`
:   Show a notification notice, with adequate default timeout

[**`f1_help`**]{#f1_help data-4search="ui/b/shell.tsx:f1_help;func"}  `(`*event*`)`
:   Open related help page in another window on F1

[**`sidebar_mouse`**]{#sidebar_mouse data-4search="ui/b/shell.tsx:sidebar_mouse;func"}  `(`*e*`)`
:   Drag and resize sidebar handle

[**`select_file`**]{#select_file data-4search="ui/b/shell.tsx:select_file;func"}  `(`*opt*`)`
:   Show file selector dialog

[**`async_modal_dialog`**]{#async_modal_dialog data-4search="ui/b/shell.tsx:async_modal_dialog;func"}  `(`*args*`)`
:   Create dialog via BModalDialogs.async_modal_dialog()

Functions

[list_sample_files]{#list_sample_files data-4search="ui/b/shell.tsx:list_sample_files;func"} () : Crawl to find relevant files for the tree browser