picoware.applications.utilities.pico

module documentation

PicoIDE - Create, edit, and run source files.

Function	`run`	Run the app.
Function	`start`	Start the app.
Function	`stop`	Stop the app.
Constant	`STATE_EDITOR`	Undocumented
Constant	`STATE_FILE_BROWSER`	Undocumented
Constant	`STATE_FILE_TYPE_MENU`	Undocumented
Constant	`STATE_INITIAL_MENU`	Undocumented
Constant	`STATE_KEYBOARD`	Undocumented
Constant	`STATE_RUNNING`	Undocumented
Function	`__callback_filename_save`	Callback for when the filename is saved.
Function	`__template`	Return a basic Picoware app template.
Function	`_ensure_extension`	Undocumented
Function	`_language_for_filename`	Undocumented
Function	`_run_file`	Execute the specified file based on its extension.
Function	`_start_editor`	Start the pye editor with the specified filename.
Function	`_start_file_browser`	Start the file browser for selecting an existing app.
Function	`_start_file_type_menu`	Start the file type menu.
Function	`_start_initial_menu`	Start the initial menu to choose between new file or edit existing.
Variable	`_file_browser`	Undocumented
Variable	`_file_type_menu`	Undocumented
Variable	`_filename`	Undocumented
Variable	`_initial_menu`	Undocumented
Variable	`_keyboard_just_started`	Undocumented
Variable	`_runner`	Undocumented

def run(view_manager): ¶

Run the app.

Parameters
view_manager:`ViewManager`	The view manager context.

@keyboard_required
@storage_required

def start(view_manager) -> bool: ¶

Start the app.

Parameters
view_manager:`ViewManager`	The view manager context.

Returns
`bool`	True on success.

def stop(view_manager): ¶

Stop the app.

Parameters
view_manager:`ViewManager`	The view manager context.

STATE_EDITOR = ¶

Undocumented

Value

const(4)

STATE_FILE_BROWSER = ¶

Undocumented

Value

const(3)

STATE_FILE_TYPE_MENU = ¶

Undocumented

Value

const(2)

STATE_INITIAL_MENU = ¶

Undocumented

Value

const(0)

STATE_KEYBOARD = ¶

Undocumented

Value

const(1)

STATE_RUNNING = ¶

Undocumented

Value

const(5)

def __callback_filename_save(result: str): ¶

Callback for when the filename is saved.

Parameters
result:`str`	The typed filename.

def __template(filename: str) -> str: ¶

Return a basic Picoware app template.

Parameters
filename:`str`	The app filename.

Returns
`str`	The template source.

def _ensure_extension(filename, extension): ¶

Undocumented

def _language_for_filename(filename): ¶

Undocumented

def _run_file(view_manager, filename) -> bool: ¶

Execute the specified file based on its extension.

Parameters
view_manager:`ViewManager`	The view manager context.
filename:`str`	The file to execute.

Returns
`bool`	True if the file was successfully executed, False otherwise.

def _start_editor(view_manager, filename=None, create_template=False): ¶

Start the pye editor with the specified filename.

Parameters
view_manager:`ViewManager`	The view manager context.
filename:`str`	The file to edit. Defaults to None.
create_template:`bool`	Create a template if the file is empty. Defaults to False.

def _start_file_browser(view_manager): ¶

Start the file browser for selecting an existing app.

Parameters
view_manager:`ViewManager`	The view manager context.

def _start_file_type_menu(view_manager): ¶

Start the file type menu.

Parameters
view_manager:`ViewManager`	The view manager context.

def _start_initial_menu(view_manager): ¶

Start the initial menu to choose between new file or edit existing.

Parameters
view_manager:`ViewManager`	The view manager context.

_file_browser = ¶

Undocumented

_file_type_menu = ¶

Undocumented

_filename: str = ¶

Undocumented

_initial_menu = ¶

Undocumented

_keyboard_just_started: bool = ¶

Undocumented

_runner = ¶

Undocumented

picoware.applications.utilities.pico_ide

`picoware.applications.utilities.pico_ide`