From 2e1d1585e913c8d81462d30ecf9a5ad87660c589 Mon Sep 17 00:00:00 2001 From: chriskiehl Date: Sun, 28 Jan 2018 12:06:16 -0800 Subject: [PATCH] update global config table --- README.md | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8b8bed0..2aa6747 100644 --- a/README.md +++ b/README.md @@ -239,8 +239,8 @@ Just about everything in Gooey's overall look and feel can be customized by pass |-----------|---------| | encoding | Text encoding to use when displaying characters (default: 'utf-8') | | use_legacy_titles | Rewrites the default argparse group name from "Positional" to "Required". This is primarily for retaining backward compatibilty with previous versions of Gooey (which had poor support/awareness of groups and did its own naive bucketing of arguments). | -| advanced | Toggles whether to show the 'full' configuration screen, or a simplified version | -| show_config | Skips the configuration all together and runs the program immediately | +| advanced | Toggles whether to show the 'full' configuration screen, or a simplified version | +| auto_start | Skips the configuration all together and runs the program immediately | | language | Tells Gooey which language set to load from the `gooey/languages` directory.| | target | Tells Gooey how to re-invoke itself. By default Gooey will find python, but this allows you to specify the program (and arguments if supplied).| |program_name | The name displayed in the title bar of the GUI window. If not supplied, the title defaults to the script name pulled from `sys.argv[0]`. | @@ -254,13 +254,18 @@ Just about everything in Gooey's overall look and feel can be customized by pass | image_dir | Path to the directory in which Gooey should look for custom images/icons | | language_dir | Path to the directory in which Gooey should look for custom languages files | | disable_stop_button | Disable the `Stop` button when running | +| show_stop_warning | Displays a warning modal before allowing the user to force termination of your program | +| force_stop_is_error | Toggles whether an early termination by the shows the success or error screen | +| show_success_modal | Toggles whether or not to show a summary modal after a successful run | +| run_validators | Controls whether or not to have Gooey perform validation before calling your program | +| poll_external_updates | (Experimental!) When True, Gooey will call your code with a `gooey-seed-ui` CLI argument and use the response to fill out dynamic values in the UI (See: [Using Dynamic Values](#using-dynamic-values))| | progress_regex | A text regex used to pattern match runtime progress information. See: [Showing Progress](#showing-progress) for a detailed how-to | | progress_expr | A python expression applied to any matches found via the `progress_regex`. See: [Showing Progress](#showing-progress) for a detailed how-to | | disable_progress_bar_animation | Disable the progress bar | | navigation | Sets the "navigation" style of Gooey's top level window.
Options:
TABBEDSIDEBAR
| | navigation_title | Controls the heading title above the SideBar's navigation pane. Defaults to: "Actions" | -| show_sidebar | Show/Hide the sidebar in when navigation mode == `SIDEBAR` | -| body_bg_color | HEX value of the main Gooey window | +| show_sidebar | Show/Hide the sidebar in when navigation mode == `SIDEBAR` | +| body_bg_color | HEX value of the main Gooey window | | header_bg_color | HEX value of the header background | | header_height | height in pixels of the header | | header_show_title | Show/Hide the header title | @@ -411,9 +416,15 @@ With the validator in place, Gooey can present the error messages next to the re +--------------------------------------- + +## Using Dynamic Values ---------------------------------------- +TODO + + +-------------------------------------- ## Customizing Icons