tkgui.tkgui module

TKinter-based GUI for PyLNP.

class tkgui.tkgui.TkGui

Bases: object

Main GUI window.

static change_entry(key, var)

Commits a change for the control specified by key.

Parameters:

• key – The key for the control that changed.

• var – The variable bound to the control.

check_cross_thread()

Used to raise cross-thread events in the UI thread.

configure_terminal(first_run=False)

Configures the command used to launch a terminal on Linux. If first_run is set, a terminal will be selected automatically.

configure_updates(days)

Sets the number of days until next update check.

confirm_downloading()

Ask the user if downloading may proceed.

create_menu(root)

Creates and returns the menu bar.

Parameters:

root – Root window for the menu bar.

create_tab(class_, caption)

Creates a new tab and adds it to the main Notebook.

Parameters:

• class_ – Reference to the class representing the tab.

• caption – Caption for the newly created tab.

static cycle_option(field)

Cycles through possible values for an option.

Parameters:

field – The option to cycle.

download_progress(queue, url, progress, total)

Event handler for download progress.

end_download(queue, url, target, success)

Event handler for the end of a download.

end_download_queue(queue)

Event handler for the end of a download queue.

ensure_df()

Ensures a DF installation is active before proceeding.

exit_program()

Quits the program.

load_params()

Reads configuration data.

migrate_settings()

Migrates settings from a previous DF install.

static on_invalid_config(errors)

Notifies a user about an invalid configuration.

on_program_running(path, is_df)

Called by the main LNP class if a program is already running.

on_query_migration()

If no saves are detected, offer to import from an older pack.

on_request_update_permission(interval)

Asks the user if update checking should be performed.

on_resize()

Called when the window is resized.

on_update_available()

Called by the main LNP class if an update is available.

static populate_menu(collection, menu, method)

Populates a menu with items from a collection.

Parameters:

• collection – A collection of menu item data.

• menu – The menu to create the items under.

• method – The method to be called when the menu item is selected.

reload_program()

Reloads the program to allow the user to change DF folders.

restore_defaults()

Restores default configuration data.

static run_df()

Launches Dwarf Fortress, reporting any errors when launching.

run_init()

Opens the init editor.

static run_program(path)

Launches another program.

Parameters:

path – Path to the program to launch.

static save_params()

Writes configuration data.

send_update_event(force=False)

Schedules an update for the download text, if not already pending.

static set_autoclose()

Toggles automatic closing of the launcher.

set_downloads()

Sets the option for auto-download of baselines.

static set_option(field)

Sets an option directly.

Parameters:

field – The field name to change. The corresponding value is automatically read.

set_show_scroll()

Toggles if scroll bars should always be shown. Used to work around a bug with some themes that modify Windows system files.

static show_about()

Shows about dialog for the program.

static show_df_info()

Shows basic information about the current DF install.

static show_help()

Shows help for the program.

start()

Starts the UI.

start_download(queue, url, target)

Event handler for the start of a download.

start_download_queue(queue)

Event handler for starting a download queue.

update_download_text()

Updates the text in the download information.

tkgui.tkgui.fixed_map(option)

Sets text colour for Tkinter 8.6.9

tkgui.tkgui.get_image(filename)

Open the image with the appropriate extension.

Parameters:

filename – The base name of the image file.

Returns:

A PhotoImage object ready to use with Tkinter.

tkgui.tkgui.validate_number(value_if_allowed)

Validation method used by Tkinter. Accepts empty and float-coercible strings.

Parameters:

value_if_allowed – Value to validate.

Returns:

True if value_if_allowed is empty, or can be interpreted as a float.