Differences

This shows you the differences between two versions of the page.

--- user-guide:panel_options [2024/07/05 15:47] – gaetan
+++ user-guide:panel_options [2024/07/05 16:56] (current) – gaetan
@@ Line 1: / Line 1: @@
-====== Preference panel ======
+====== Preferences panel ======
 In GroIMP the preferences (from java preferences) are the software options.
@@ Line 10: / Line 10: @@
   * [[:groimp-platform:raytracing:raytracer_options|Options for the raytracer]]
   * [[:user-guide:command-line-arguments|Add a Option file on startup]]
+  * [[:user-guide:all-options-core|List of all options from the core]]
 ===== Global options =====
@@ Line 16: / Line 16: @@
 Usually when a user change the options of GroIMP, he changes the global options. These options are stored when set in the java preferences (in ''~/.java/.userPrefs/de/grogra/options/'' + path of the option). This enables the options to be persistent between GroIMP uses. It also makes the options persistent when an other version of GroIMP is installed.
-Global options are used by every workbench that do not include an option file.
+Global options are used by every workbenches that do not include an option file.
-The panel of global options can be open if the currently used workbench do not have an option file. In that case, when the preference panel is open (with ''Panel>Preferences'') you can see the Label on the bottom right that tells the current panel is Global (see the red circle on the image).
+The panel of global options can be open if the currently used workbench do not have an option file. In that case, when the preference panel is open (with ''Panel>Preferences'') you can see the Label on the bottom right that tells the current panel is Global (see the red circle on the Image 1.).
 {{:user-guide:global_preferences_panel.png}}
+//Image 1: Global preference panel//
 ===== Workbench options =====
-GroIMP also support options specific for a given workbench (since version 2.1.4).
+GroIMP also support options specific for a given workbench (since version 2.1.4). The option file (called "workbench.options") is shipped with the GroIMP project (at the root of the project.gs file, or in the .gsz archive). It enables to share a project with a specific set of options.
+When the option file exists in a project, GroIMP will use its options instead of the global ones. If an option file contains more options than the current instance of GroIMP, these options are kept but not use. If the option miss some options that the current instance of GroIMP defined, these options are added to the option file when saved.
+The option file can be added in a workbench from the preference panel (''Panel>Preferences''). On the menu bar (see Image 2) ''file>options>Create current workbench option file''.
+{{:user-guide:panel_opt_add.png}}
+//Image 2: menu options//
+Once the option file is added, the view of the preference panel will change into the workbench option view (see Image 3). In that view the name of the workbench whose options are managed is displayed in the red circle **1**. On the bottom right a button to open the global options is available (see the red circle **2**).
 {{:user-guide:wb_preferences_panel.png}}
+//Image 3: workbench option panel//
+When a option file is created and added to the project it is automatically setup with all the existing current global options.
+When modifying workbench options, the options new value is directly updated, however the option file **is not** automatically updated. To push the modification to the option file the project needs to be saved.
+To stop using the option file of a workbench, it can be deleted from the menu option (see Image 2): ''file>options>Delete current option file''.
+The file can be modified outside of GroIMP as plain text.
+To add an option file in a project outside of GroIMP, the file needs to be added **and** the registry item //OptionsSource// needs to be added to the project.gs. Same when deleting the option file from outside of GroiMP: both the both the file and the registry item needs to be deleted. The MANIFEST.MF file must be updated as well.
 ===== Options for the Swing User Interface =====
@@ Line 38: / Line 58: @@
 If you switch to another Look & Feel in the Preferences panel, the user interface will be redrawn immediately. However, changing the window decorations option only takes effect when a new window is opened. Also, there are Look & Feels which do not support window decorations.
+See more:
+  * [[https://gitlab.com/grogra/groimp-plugins/extraLaf|Additional plugin for extra LaF]]