settings_screen
A subscreen that allows for setting a variety of pyautogit settings.
Classes
| Class | Doc |
|---|---|
| SettingsScreen(pyautogit.screen_manager.ScreenManager) | Class representing settings subscreen for pyautogit |
SettingsScreen(pyautogit.screen_manager.ScreenManager)
class SettingsScreen(pyautogit.screen_manager.ScreenManager)
Class representing settings subscreen for pyautogit
Attributes
| Attribute | Type | Doc |
|---|---|---|
| current_info_log | str | The current settings log text |
| show_settings_log | bool | Toggle for showing settings log |
Methods
| Method | Doc |
|---|---|
| initialize_screen_elements | Override of base class function. Initializes widgets, and returns widget set |
| set_initial_values | Function that sets initial status bar text for settings window |
| add_to_settings_log | Function that updates the settings info log panel |
| fetch_about_file | Function that grabs file from github and displays it in info panel |
| revert_settings_log | Function that resets to showing settings info |
| open_web_docs | Function tasked with open docs in external browser |
| show_tutorial | Function that demonstrates tutorial for using pyautogit |
| ask_log_file_path | Prompts user to enter log file path |
| get_settings_ascii_art | Gets ascii art settings logo |
| toggle_editor_type | Function that toggles between internal and external editor |
| toggle_logging | Function that enables/disables logging |
| ask_default_editor | Function that asks user for editor, and then refreshes |
| update_default_editor | Function that updates the new default editor |
| update_log_file_path | Function that updates log file path if valid |
| refresh_status | Override of base class refresh function. |
init
def __init__(self, top_manager)
Constructor for SettingsScreen
initialize_screen_elements
def initialize_screen_elements(self)
Override of base class function. Initializes widgets, and returns widget set
Returns
| Return Variable | Type | Doc |
|---|---|---|
| settings_widget_set | py_cui.widget_set.WidgetSet | Widget set object for rsettings screen |
set_initial_values
def set_initial_values(self)
Function that sets initial status bar text for settings window
add_to_settings_log
def add_to_settings_log(self, text)
Function that updates the settings info log panel
Parameters
| Parameter | Type | Doc |
|---|---|---|
| text | str | New log item to write to settings info panel |
fetch_about_file
def fetch_about_file(self, file)
Function that grabs file from github and displays it in info panel
Parameters
| Parameter | Type | Doc |
|---|---|---|
| file | str | Filename to fetch from github repository |
revert_settings_log
def revert_settings_log(self)
Function that resets to showing settings info
open_web_docs
def open_web_docs(self)
Function tasked with open docs in external browser
show_tutorial
def show_tutorial(self)
Function that demonstrates tutorial for using pyautogit
ask_log_file_path
def ask_log_file_path(self)
Prompts user to enter log file path
get_settings_ascii_art
def get_settings_ascii_art(self)
Gets ascii art settings logo
Returns
| Return Variable | Type | Doc |
|---|---|---|
| settings_message | str | Block letter ascii art settings logo |
toggle_editor_type
def toggle_editor_type(self)
Function that toggles between internal and external editor
toggle_logging
def toggle_logging(self)
Function that enables/disables logging
ask_default_editor
def ask_default_editor(self)
Function that asks user for editor, and then refreshes
update_default_editor
def update_default_editor(self, new_editor)
Function that updates the new default editor
Parameters
| Parameter | Type | Doc |
|---|---|---|
| new_editor | str | command used to open external editor |
update_log_file_path
def update_log_file_path(self, new_log_file_path, default_path=False)
Function that updates log file path if valid
Parameters
| Parameter | Type | Doc |
|---|---|---|
| new_log_file_path | str | Path to new log file |
refresh_status
def refresh_status(self)
Override of base class refresh function.