3 \page setting_preferences_page Setting Preferences
5 All user preferences of \b SALOME application can be customized using the
6 common \b Preferences dialog box. This dialog can be open using the
7 <b><i>File > Preferences...</i></b> menu item.
9 The \b Preferences dialog box consists of two parts:
10 - Available preferences sections are listed in the left part of the dialog
11 box; usually this list contains "SALOME" item that specifies general
12 application preferences and a separate section for each SALOME module
13 available in the current session.
14 - The tabbed widget at the right side of the dialog box provides
15 controls that can be used to customize the preferences.
17 \note The preferences for modules become accessible only after
18 explicit loading of these modules. Until then the dialog box will
19 show the corresponding warning message.
21 More detailed information about preferences for certain modules can be found in the User's guide of the corresponding module.
23 General application preferences are specified in the \b SALOME section
24 of the \b Preferences dialog box. These preferences affect on the
25 application look-n-feel and common functionality.
27 If the study has just been started and other
28 modules have not been loaded yet, it will be possible to change only the settings which refer to
29 the whole GUI SALOME session.
31 <h2>General Preferences</h2>
33 \image html pref_salome_general.png
36 - <b>Current language</b> - the language used by the application
37 GUI. The language change will come in force only after the application is restarted.
38 - <b>Use C locale</b> - when checked, the C locale will be set for the application,
39 otherwise a system locale will be used. The locale change will come in force only after
40 the application is restarted.
41 - <b>Look and feel</b>
42 - <b>Opaque resize</b> - force opaque resize mode for viewers area (tabbed workspace).
43 Clear this checkbox for less perfomant workstations.
44 - <b>Drop-down buttons in toolbars for action groups</b> - when
45 checked, the action groups are represented in the viewer toolbars as
46 a single drop-down button, switchable by the user. Otherwise, all
47 the buttons from the action groups are displayed in the toolbar.
48 - <b>Study Properties</b>
49 - <b>Multi file save</b> - if checked in, your study will be saved in
50 several HDF files (one basic HDF file which will store the main
51 information about the saved study and several other files for the
52 data created by each component used during the study
53 session). Opening of this study requires that \b ALL saved files
54 should be stored in the \b SAME directory. If you would like to
55 copy your saved study in another directory or machine, you should
56 copy all stored files. Otherwise, if you try to open this study,
57 some data will be lost and it will lead to invalid functioning of
59 - <b>ASCII save</b> - if checked in, your study will be saved in
60 ASCII format file (or files).
61 - <b>Store positions of windows</b> - if checked in, positions of windows
62 will be saved in a special file at the end of the current session and
63 then restored for a new session.
64 - <b>Store positions of toolbars</b> - if checked in, positions of toolbars
65 will be saved in a special file at the end of the current session and
66 then restored for a new session.
67 - <b>Auto-save interval (min)</b> - allows to specify the time interval (in
68 minutes) for automatic study saving operation. If the time interval is
69 equal to 0 ("Disabled" value is shown) the automatic saving is not performed.
70 - <b>Store/restore last GUI state</b> - if checked in, all GUI settings are
71 saved with the rest of the data whenever you save the study. When the
72 study is reopened, the GUI state is restored.
73 - <b>Multi file python dump</b> - allows to generate multiple files
74 (separately for each component) for dumping of a study to a python script.
75 If the option is disabled, the study is dumped to a single python script.
76 - <b>Publish in study in python dump</b> - if this option is switched on,
77 the Python script resulting from Dump Python operation will
78 include commands related to the publication of the data in the
79 study (if this option is supported by specific module).
80 - <b>Save GUI state in python dump</b> - if this option is switched on,
81 the Python script resulting from Dump Python operation will
82 include commands related to the GUI state.
83 - <b>External browser</b> - allow to define what browser will
84 be used to show SALOME reference manuals: internal (built-in
85 SALOME browser) or external (IE, Netscape, Mozilla, ...). In
86 addition, it is possible to specify
87 - \b Application - this option allows you to set an external browser (IE,
88 Netscape) which will be used for viewing SALOME reference manuals. By
89 default, Mozilla is used.
90 - \b Parameters - additional parameters required for launching of
91 the external browser (if applicable).
92 - <b>Python console</b> - here you can quickly set the parameters
93 (style, size, face) of the \ref font_color_dlg "font" used in
94 embedded Python console.
95 - <b>Show MRU items</b> - allows to define the maximum \b Number of
96 items in <b>Most Recently Used</b> list and the <b>Link type</b>:
97 - \b Long - shows the full path to the file.
98 - \b Short - shows the file name only.
99 - \b Auto - shows full paths to the files only if some files from
100 different locations have the same name.
102 <h2>3D Viewer Preferences</h2>
104 \image html pref_salome_3dviewer.png
106 - <b>Navigation style</b> - this option allows to choose one of the
107 modes of work with mouse in OCC and VTK 3D viewers.
108 - <b>Salome Standard Controls</b> - allows to manipulate objects in the
109 viewer with the mouse and locked Ctrl button: increase or decrease the
110 zoom ratio with the left mouse button, translate object in any
111 direction with the central mouse button or rotate it with the right
113 - <b>Keyboard Free</b> - allows to manipulate objects in the viewer
114 with the mouse without locking Ctrl button. In this case the
115 operations are assigned to the buttons differently: rotation is made
116 with the left button, translation with the right and zoom with both
117 pressed in the same time.
118 - <b>Zooming style</b> - this option allows to choose a zooming mode.
119 - <b>Relative to the view's center</b> - allows to zoom the view
120 relatively to its center.
121 - <b>Relative to the cursor</b> - allows to zoom the view
122 relatively to the current cursor position.
123 - <b>Trihedron</b> - viewer trihedron settings:
124 - <b>Size</b> - size of the coordinate axes (global trihedron)
125 displayed in the viewer.
126 - <b>Relative size</b> - if this option is switched on, trihedron
127 axes scale to fit the size of the scene displayed in 3D viewer.
128 - <b>Show static trihedron</b> - allows to show/hide the static
129 mini-trihedron located in the bottom-left corner of the viewer.
131 \anchor occ_preferences
132 <h2>OCC 3D Viewer Preferences</h2>
134 \image html pref_salome_occviewer.png
136 - <b>Background</b> - specifies the default background for the viewers,
137 separately for (for more details, refer to the \ref viewer_background
144 \anchor vtk_preferences
145 <h2>VTK 3D Viewer Preferences</h2>
147 \image html pref_salome_vtkviewer.png
149 - <b>Projection mode</b> - allows choosing between \b Orthogonal and
150 \b Perspective projection mode.
151 - <b>Background</b> - specifies the default background for the viewer;
152 for more details, refer to the \ref viewer_background "this page".
153 - <b>Speed Increment</b> - defines the number of units by
154 which the speed increases or respectively decreases after pressing [+]
155 or [-] keyboard buttons.
156 - <b>Modification Mode</b> - allows choosing between \b Arithmetic
157 and \b Geometrical progression used for zooming.
158 - <b>Dynamic pre-selection</b> - switches dynamic pre-selection on/off.
159 - <b>Spacemouse</b> - a mouse-like manipulator device specially designed
160 for working with 3D presentations, objects, etc. You can reassign the
161 actions listed below to any of its buttons.
162 - <b>Decrease Speed Increment</b> - decreases by 1 the speed
163 increment used for the keyboard (same as [-] key).
164 - <b>Increase Speed Increment</b> - increase by 1 the speed
165 increment used for the keyboard (same as [+] key).
166 - <b>Dominant / combined switch</b> - toggles button to switch to
167 dominant or combined movements.
168 - <b>AVI Recording</b>
169 - <b>Mode</b> - allows to choose from two recording regimes:
170 - <b>Recording all displayed frames</b> - records exactly at the
171 FPS rate specified by the user.
172 - <b>Recording at a given FPS</b> - records only when the contents
173 of the viewer change (some activity is performed). In the AVI file
174 non-recorded images are substituted with the copies of the latest
175 recorded image, which produces files with lower quality but requires
176 less system resources.
177 - <b>FPS</b> - allows to define the FPS (frames per second) rate for
178 the clip. Set greater value for better quality.
179 - <b>Quality</b> - allows to set the quality of the clip in the
180 interval between 0 and 100.
181 - <b>Progressive</b> - allows to record a progressive API file.
182 - <b>Names of groups</b> - allows to specify parameters of the
183 titles displayed in the viewer:
184 - <b>Text color</b> - allows selecting the text color;
185 - <b>Transparency</b> - allows selecting the text transparency.
187 \anchor plot2d_preferences
188 <h2>Plot 2D Viewer Preferences</h2>
190 \image html pref_salome_plot2dviewer.png
192 - <b>Background color</b> - this submenu allows to select the background
193 color. Click on the colored line to access to the
194 \ref select_color_and_font_page "Select Color" dialog box.
195 - <b>Selection color</b> - this submenu allows to select the color of
196 selected object in the viewer.
197 - <b>Viewer</b> - allows specifying the properties of the Plot 2D Viewer.
198 - <b>Curve Type</b> - this allows to set the representation of graphs in
199 your presentations. You can see only <b>Points</b>, points connected with
200 <b>Lines</b> or points connected with smooth <b>Splines</b>.
201 - <b>Marker Size</b> - this submenu allows you to set the size of
202 markers in your graphs.
203 - <b>Horizontal</b> and <b>Vertical axis scale</b> - this submenus allow you to set
204 the scale for vertical and horizontal axes. It can be either <b>Linear</b> or
205 <b>Logarithmic</b>. Note that the <b>Logarithmic</b> scale can be used only
206 if the minimum value of corresponding component (abscissa or ordinate)
207 of all points displayed in the viewer is greater than zero.
208 If this condition is not met, the scale is switched to <b>Linear</b>
209 automatically, even if it is set to <b>Logarithmic</b>.
210 - <b>Deviation marker color</b> - this submenu allows to select the
211 color of the deviation marker.
212 - <b>Deviation marker line width</b> allows to define line width of
213 the deviation marker.
214 - <b>Deviation marker tick size</b> allows to define size of the upper
215 and lower horizontal lines of the deviation marker.
216 - <b>Legend</b> - allows specifying the properties of the legend.
217 - <b>Show legend</b> - this options specifies if it's necessary to
218 show legend by default.
219 - <b>Legend Position</b> - this submenu allows to set the default position
220 of the legend, it can be located to the left, to the right, on top or
221 on bottom of the graph.
222 - <b>Symbol type</b> you can select the type of legend item symbol from "Marker on line"
223 or "Marker above line"
224 - <b>Legend font</b> - this allows to set type and face for the font of Legend item.
225 - <b>Legend font color</b> - this allows to select the color of the
226 font of the legend item.
227 - <b>Highlighted legend font color</b> - this submenu allows to select
228 the color of the font of the selected legend item.
230 <br><h2>Directories Preferences</h2>
232 \image html pref_salome_directories.png
234 - <b>Quick Directory List</b> - this section allows to create and manage
235 a custom quick directory list. To add a directory in the list, press
236 the "Add directory" button:
237 \image html image70.png
238 then the "<b>...</b>" button and browse the data tree for the
240 The "Up" and "Down" buttons(see the picture below) help you to sort
241 the directories in the list:
242 \image html image73.png
243 \image html image75.png
244 To remove the selected directory from the list, press the "Delete"
246 \image html image72.png
248 <br><h2>Object Browser Preferences</h2>
250 \image html pref_salome_objbrowser.png
252 - <b>Search Tool</b> - specifies behavior of the
253 \ref using_find_tool_page "Search tool".
254 - <b>Enable auto-hiding</b> checkbox - hides the search tool
255 automatically after short perioud of time when it is not used.
256 - <b>Look and feel</b>
257 - <b>Auto size for the first column</b> - this checkbox enables automatic
258 resizing for the first column.
259 - <b>Auto size for other columns</b> - this checkbox enables
260 automatic resizing for the other columns.
261 - <b>Resize columns after expanding an item</b> - this checkbox enables
262 resizing columns on expanding an object browser item.
263 - <b>Browse to the published object</b> - this combobox allows to enable
264 automatic browsing to the objects just published to the study (using GUI
265 dialogs only). It means that the object browser will be scrolled to the
266 published objects, make them visible if they are collapsed and select the
267 first of them. Three modes are allowed for activating this feature:
268 - <b>Never</b> - automatic browsing is disabled.
269 - <b>After Apply & Close only</b> - browsing is activated when the
270 dialog is accepted by <b>Apply & Close</b> or <b>Ok</b> buttons (or if
271 the objects are published without using a dialog, for example, by
272 clicking a context menu button) and not activated when the
273 <b>Apply</b> button is pressed and therefore the dialog remains visible.
274 - <b>Always</b> - automatic browsing is always enabled.
275 - <b>Default columns</b> - these checkboxes allow to display or hide <b>Value</b>,
276 <b>Entry</b>, <b>IOR</b> and <b>Reference entry</b> columns in the Object Browser.
278 <br><h2>Shortcuts Preferences</h2>
280 \image html pref_salome_shortcuts.png
282 - <b>Shortcuts settings</b> widget allows to define custom shortcuts for
283 various operations. To change keyboard sequence for a certain action - select the
284 action and press the custom keys combination.
287 \subpage select_color_and_font_page "Font and color preferences"
288 are most oftenly used types of user settings.
290 When you change settings (click \b OK or \b Apply button) each module
291 receives the notification about what preferences are changed. You can
292 also click \b Defaults button to restore default preferences or \b Close
293 button to quit the dialog box without any changes.
295 \b Import button allows loading specific user file containing
296 preferences from any location at the computer through a standard
299 \image html import.png
301 The preferences files usually have *.xml extension. Also,
302 preferences files automatically saved by the application (stored in the
303 ~/.config/salome directory) have no extension and by default start with
304 .SalomeApprc. followed by SALOME version number. Usually there is a
305 separate preferences file for each SALOME version in use. Preferences
306 are saved to the file in the end of the working session and restored
307 at the application start-up.
309 \note The preferences you set will be default preferences for all \b new
310 objects, but they are not retroactive and do not automatically apply
311 to the existing objects.