diff options
Diffstat (limited to 'resources/ui_layout/Readme.md')
| -rw-r--r-- | resources/ui_layout/Readme.md | 144 |
1 files changed, 101 insertions, 43 deletions
diff --git a/resources/ui_layout/Readme.md b/resources/ui_layout/Readme.md index 7d65036cb..62410091d 100644 --- a/resources/ui_layout/Readme.md +++ b/resources/ui_layout/Readme.md @@ -1,4 +1,21 @@ -# How to customize the setting UI +# UI layouts wiki + +UI layout can be selected in the `configuration->preferences->GUI->settings layout UI and colors`. +In this box, you can select the layout you want to use, each one has its directory in ui_layout in your configuration folder (use help->show configuration folder to get to it). +Note: The configuration folder is created at the first launch of superslicer. + +## add a new layout + +To add a new layout, copy-paste the `default` directory, and rename it to your new name ('newlayout' for this wiki) +Go inside this directory. + +Edit the version.ini file: + * the name will be displayed in the preference combobox and the description will be used as the tooltip. +Then, you can edit teh ui file to change the layout of each tab (print, filament and printer). +Note that each setting has to be in its tab, it can't change. That's why there is print_temperature, as the temperature field is linked to the filament, and can't be in a print setting. +But inside a tab, you have full control. + +# How to customize a setting UI ## How it works The software will search for each tab the needed ui files @@ -23,51 +40,70 @@ INT represent an integer parameters that are inside [] are optionals each parameter is separated by ':' * Page: - page[:idx]:STR:STR + `page[:idx]:STR:STR` * first STR is for the label and the second for the icon, with or without the .svg / .png * idx: append the index of the page (for extruder ui) to the name * Group: - group[:no_title][:title_width$INT][:label_width$INT][:sidetext_width$INT][:EVENT][:id$INT][:idx]:STR - * EVENT can be extruders_count_event if the group contains extruders_count and is a printer tab ; silent_mode_event if the group contains silent_mode and is a printer tab ; material_density_event if the group contains material_density. - * title_width$INT is used to set the size of the left column, where titles are draw. - * label_width$INT is used to set the size of the labels on lines. - * sidetext_width$INT is used to set the size of the suffix label (see sidetext in setting). - * EVENT can be extruders_count_event (TabPrinter only), silent_mode_event (TabPrinter only), material_density_event. - * no_title is used to remove the left column, where titles are draw. - * no_search to not add this group's widgets into the search tool. + `group[:no_title][:title_width$INT][:label_width$INT][:sidetext_width$INT][:EVENT][:id$INT][:idx]:STR` + * `EVENT` can be extruders_count_event if the group contains extruders_count and is a printer tab ; silent_mode_event if the group contains silent_mode and is a printer tab ; material_density_event if the group contains material_density. + * `title_width$INT` is used to set the size of the left column, where titles are draw. + * `label_width$INT` is used to set the size of the labels on lines. + * `sidetext_width$INT` is used to set the size of the suffix label (see sidetext in setting). + * `no_title` is used to remove the left column, where titles are draw. + * `no_search` to not add this group's widgets into the search tool. * Line: - line:STR* + `line:STR*` * setting: - setting[label$STR][label_width$INT][:full_label][:full_width][:sidetext$STR][sidetext_width$INT][:simple|advanced|expert][:width$INT][:height$INT][:id$INT]:STR - * STR, the last parameter: the id name of the setting. - * label$STR: to override the label by this new one (if it ends with '_' it won't have a ':' ; if empty it won't have a length). - * label_width$INT: change the width of the label. Only works if it's in a line. Override the group one. -1 for auto. - * label_left: Draw the label aligned to the left instead of the right. - * full_label$STR: to override the full_label by this new one (full_label is used on modifiers). - * full_label: to override the label by the "full one". - * full_width: to tell to create a field that span the full width. - * sidetext$STR: the suffix at the right of the widget (like 'mm'). - * sidetext_width$INT: the suffix label length (override the group one). -1 for auto. - * max_literal$INT[%]: if the user enter a value higher than that and it's a 'float or percent' field, then emit a pop-up to question if he doesn't forgot a '%'. If negative, it check if the value isn't lower than the absolute max_literal, instead of greater. If there is a '%' after the value, then it's multiplied by the biggest nozzle diameter. - * simple|advanced|expert: add one of these to modify the mode in which this setting appear. - * width$INT: change the width of the field. Shouod work on most type of settings. - * height$INT: change the height of the field. Don't works with every type of setting (mostly multilne text). Set to -1 to 'disable'. - * precision$INT: number of digit after the dot displayed. - * url$STR: the url to call when clicking on it. - * id $INT: for setting only a single value of a setting array. - * idx: for setting only a single value of a setting array, with the index of the page (for extruder ui page) -* height:INT: change the default height of settings. Don't works with every type of setting (mostly multilne text). Set to 0 or -1 to disable. -* recommended_thin_wall_thickness_description: create a text widget to explain recommended thin wall thickness (only in a fff print tab). -* parent_preset_description: create a text widget to explain parent preset. -* cooling_description: create a text widget to explain cooling (only in a filament tab). -* volumetric_speed_description: create a text widget to explain volumetric speed (only in a filament tab). -* filament_ramming_parameters: create a widget for filament ramming. -* filament_overrides_page: create a page for overrides (only in a filament tab). -* unregular_pages: create needed special pages for a fff printer tab. -* printhost: create printhost settings for the group (only in a printer tab). -* bed_shape: create bed shape widget (only in a printer tab). -* extruders_count: create extruders_count setting (only in a fff printer tab). -* logs: activated logs. + `setting[label$STR][label_width$INT][:full_label][:full_width][:sidetext$STR][sidetext_width$INT][:simple|advanced|expert][:width$INT][:height$INT][:id$INT]:STR` + * `STR`, the last parameter: the id name of the setting. + * `label$STR`: to override the label by this new one (if it ends with '_' it won't have a ':' ; if empty it won't have a length). + * `label_width$INT`: change the width of the label. Only works if it's in a line. Override the group one. -1 for auto. + * `label_left`: Draw the label aligned to the left instead of the right. + * `full_label$STR`: to override the full_label by this new one (full_label is used on modifiers). + * `full_label`: to override the label by the "full one". + * `full_width`: to tell to create a field that span the full width. + * `sidetext$STR`: the suffix at the right of the widget (like 'mm'). + * `sidetext_width$INT`: the suffix label length (override the group one). -1 for auto. + * `max_literal$INT[%]`: if the user enter a value higher than that and it's a 'float or percent' field, then emit a pop-up to question if he doesn't forgot a '%'. If negative, it check if the value isn't lower than the absolute max_literal, instead of greater. If there is a '%' after the value, then it's multiplied by the biggest nozzle diameter. + * `tags$STR[$STR]*`: to set the tags in which the setting can show up. Each tag has to be suffixed by a `$`. + * simple|advanced|expert: old way to set the tags: simple will set the tags to 'Simple', advanced will set the tags to 'Simple' and 'Advanced', and 'expert' will set the tags to 'Simple' 'Advanced' and 'Expert'. + * `width$INT`: change the width of the field. Shouod work on most type of settings. + * `height$INT`: change the height of the field. Don't works with every type of setting (mostly multilne text). Set to -1 to 'disable'. + * `precision$INT`: number of digit after the dot displayed. + * `url$STR`: the url to call when clicking on it. + * `id $INT`: for setting only a single value of a setting array. + * `idx`: for setting only a single value of a setting array, with the index of the page (for extruder ui page) + * `script`: to tell that this setting doesn't exist and is defined in a script (see script section). You have to also define the type. They comes in two flavor: single value and array (Single values have to be used, but for filament and extruder tabs that require arrays): + * `bool`: Single vlaue. Tell the sotfware it's a checkbox (boolean return value) + * `int`: Single vlaue. Tell the sotfware it's a int entry field (int return value) + * `float`: Single vlaue. Tell the sotfware it's a numeric entry field (float return value) + * `percent`: Single vlaue. Tell the sotfware it's a percentage (float return value) + * `float_or_percent`: Single vlaue. Tell the sotfware it's a numeric that can acept a % value (float return value) + * `string`: Single vlaue. Tell the sotfware it's a numeric an entry field where you can enter a text(string return value) + * `bools`: Array. Tell the sotfware it's a checkbox (boolean return value) + * `ints`: Array. Tell the sotfware it's a int entry field (int return value) + * `floats`: Array. Tell the sotfware it's a numeric entry field (float return value) + * `percents`: Array. Tell the sotfware it's a percentage (float return value) + * `floats_or_percents: mandatory`: Array. Tell the sotfware it's a numeric that can acept a % value (boolean return value) + * `strings`: Array. Tell mandatory for a filament or an extruder value. The sotfware it's a numeric an entry field where you can enter a text(string return value) + * `enum$STR$STR[$STR$STR]*`: tell the sotfware it's a combobox (string return value). It has to be followed by $name$label for each option you want to show. +Also, script may depends on normal fields. When a setting it depends is modified, the scripted widget will appear modified. And resetting a widget will reset all depending fields. + * `depends$STR[$STR]*`: add the setting fields this scripted widget depends on. Each one has to be suffixed by a '$' + +There is also special commands: +* `height:INT`: change the default height of settings. Don't works with every type of setting (mostly multilne text). Set to 0 or -1 to disable. +* `recommended_thin_wall_thickness_description`: create a text widget to explain recommended thin wall thickness (only in a fff print tab). +* `parent_preset_description`: create a text widget to explain parent preset. +* `cooling_description`: create a text widget to explain cooling (only in a filament tab). +* `volumetric_speed_description`: create a text widget to explain volumetric speed (only in a filament tab). +* `filament_ramming_parameters`: create a widget for filament ramming. +* `filament_overrides_page`: create a page for overrides (only in a filament tab). +* `unregular_pages`: create needed special pages for a fff printer tab. +* `printhost`: create printhost settings for the group (only in a printer tab). +* `bed_shape`: create bed shape widget (only in a printer tab). +* `extruders_count`: create extruders_count setting (only in a fff printer tab). +* `logs`: activated logs. + ### ui file syntax trailing & leading tabs & spaces are removed, so you can indent as you want. If the first character is '#', then this line is ignored @@ -85,5 +121,27 @@ exemple: end_group end_page -## notes -A print.ui.legacy is here with the prusaslicer tabs, just rename print.ui and remove the .legacy to switch from the Slic3r print layout to prusaslicer print layout. +# Scripts + +## how to write a script + +The file the script is written is a .as file. If a scripted widget is used in the print.ui file, then it has to be defined in the print.as file. + +The language used is [angelscript](https://www.angelcode.com/angelscript). + +To write the functions for a scripted widget with a 'my_widget' name and a type 'int', then you have to write these methods: +* int my_widget_get() +* void my_widget_set(int value) + +The first one is called when the gui need the value to display. +The second one is called when the user change the value in the gui. + +At the start of the print.ui file, there is a little dictionnary with he methods available for the script to call. +It also contains the list of methods needed for all types (not only int). + +## frequent settings + +The files freq_fff.ui and freq_sla.ui contains teh frequent settings. +Their layout is similar as other ui files. They still have to define a page and a group. +The group has to be `group:freq_settings_event:no_title:no_search:` to not interfer witht he rest of the gui. +If it use scripted widget, they have to be in the print.as file. The syntax is similar to c++/java. |