picoware.applications.text_editor

module documentation

Text Editor - Edit text files on the device.

Function run Run the app.
Function start Start the app.
Function stop Stop the app.
Constant STATE_BROWSE Undocumented
Constant STATE_EDIT Undocumented
Constant STATE_KEYBOARD Undocumented
Constant STATE_MENU Undocumented
Function __callback_keyboard_save Called by the keyboard when the user presses Save.
Function __is_editable_file Return whether the text editor app should open this path.
Function __save_and_return_to_menu Save the current file and transition back to the menu state.
Function __start_browse Start the file browser in selector mode.
Function __start_edit Open the TextEditor for the current filename.
Function __start_keyboard Activate the on-screen keyboard for filename entry.
Function __start_menu Build and draw the main menu.
Variable _file_browser Undocumented
Variable _file_selected Undocumented
Variable _filename Undocumented
Variable _keyboard_just_started Undocumented
Variable _menu Undocumented
Variable _textbox Undocumented
def run(view_manager):

Run the app.

Parameters
view_manager:ViewManagerThe view manager context.
def start(view_manager) -> bool:

Start the app.

Parameters
view_manager:ViewManagerThe view manager context.
Returns
boolTrue on success.
def stop(view_manager):

Stop the app.

Parameters
view_manager:ViewManagerThe view manager context.
STATE_BROWSE =

Undocumented

Value
const(1)
STATE_EDIT =

Undocumented

Value
const(3)
STATE_KEYBOARD =

Undocumented

Value
const(2)
STATE_MENU =

Undocumented

Value
const(0)
def __callback_keyboard_save(result: str):

Called by the keyboard when the user presses Save.

Parameters
result:strThe typed filename.
def __is_editable_file(path: str) -> bool:

Return whether the text editor app should open this path.

Parameters
path:strThe file path to check.
Returns
boolTrue if the file is editable.
def __save_and_return_to_menu(view_manager):

Save the current file and transition back to the menu state.

Parameters
view_manager:ViewManagerThe view manager context.
def __start_browse(view_manager):

Start the file browser in selector mode.

Parameters
view_manager:ViewManagerThe view manager context.
def __start_edit(view_manager):

Open the TextEditor for the current filename.

Parameters
view_manager:ViewManagerThe view manager context.
def __start_keyboard(view_manager):

Activate the on-screen keyboard for filename entry.

Parameters
view_manager:ViewManagerThe view manager context.
def __start_menu(view_manager):

Build and draw the main menu.

Parameters
view_manager:ViewManagerThe view manager context.
_file_browser =

Undocumented

_file_selected: bool =

Undocumented

_filename: str =

Undocumented

_keyboard_just_started: bool =

Undocumented

_menu =

Undocumented

_textbox =

Undocumented