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>Show splash screen at start-up</b> - allows showing or hiding the splash screen at start-up.
43 - <b>Opaque resize</b> - force opaque resize mode for viewers area (tabbed workspace).
44 Clear this checkbox for less perfomant workstations.
45 - <b>Drop-down buttons in toolbars for action groups</b> - when
46 checked, the action groups are represented in the viewer toolbars as
47 a single drop-down button, switchable by the user. Otherwise, all
48 the buttons from the action groups are displayed in the toolbar.
49 - <b>Study Properties</b>
50 - <b>Multi file save</b> - if checked in, your study will be saved in
51 several HDF files (one basic HDF file which will store the main
52 information about the saved study and several other files for the
53 data created by each component used during the study
54 session). Opening of this study requires that \b ALL saved files
55 should be stored in the \b SAME directory. If you would like to
56 copy your saved study in another directory or machine, you should
57 copy all stored files. Otherwise, if you try to open this study,
58 some data will be lost and it will lead to invalid functioning of
60 - <b>ASCII save</b> - if checked in, your study will be saved in
61 ASCII format file (or files).
62 - <b>Store positions of windows</b> - if checked in, positions of windows
63 will be saved in a special file at the end of the current session and
64 then restored for a new session.
65 - <b>Store positions of toolbars</b> - if checked in, positions of toolbars
66 will be saved in a special file at the end of the current session and
67 then restored for a new session.
68 - <b>Auto-save interval (min)</b> - allows to specify the time interval (in
69 minutes) for automatic study saving operation. If the time interval is
70 equal to 0 ("Disabled" value is shown) the automatic saving is not performed.
71 - <b>Store/restore last GUI state</b> - if checked in, all GUI settings are
72 saved with the rest of the data whenever you save the study. When the
73 study is reopened, the GUI state is restored.
74 - <b>Publish in study in python dump</b> - if this option is switched on,
75 the Python script resulting from Dump Python operation will
76 include commands related to the publication of the data in the
77 study (if this option is supported by specific module).
78 - <b>Multi file python dump</b> - allows to generate multiple files
79 (separately for each component) for dumping of a study to a python script.
80 If the option is disabled, the study is dumped to a single python script.
81 - <b>Save GUI state in python dump</b> - if this option is switched on,
82 the Python script resulting from Dump Python operation will
83 include commands related to the GUI state.
84 - <b>External browser</b> - allows to define what browser will
85 be used to show SALOME reference manuals: internal (built-in
86 SALOME browser) or external (IE, Netscape, Mozilla, ...). In
87 addition, it is possible to specify
88 - \b Application - this option allows you to set an external browser (IE,
89 Netscape) which will be used for viewing SALOME reference manuals. By
90 default, Mozilla is used.
91 - \b Parameters - additional parameters required for launching of
92 the external browser (if applicable).
93 - <b>Python console</b>
94 - \b Font - allows quickly setting the parameters (style, size, face) of the
95 \ref font_color_dlg "font" used in embedded Python console.
96 - <b>Show banner</b> - this option allows to show/hide the Python banner
97 on top of the console window.
98 - <b>Show MRU items</b> - allows to define the maximum \b Number of
99 items in <b>Most Recently Used</b> list and the <b>Link type</b>:
100 - \b Long - shows the full path to the file.
101 - \b Short - shows the file name only.
102 - \b Auto - shows full paths to the files only if some files from
103 different locations have the same name.
105 <h2>3D Viewer Preferences</h2>
107 \image html pref_salome_3dviewer.png
109 - <b>Navigation style</b> - this option allows to choose one of the
110 modes of work with mouse in OCC and VTK 3D viewers.
111 - <b>Salome Standard Controls</b> - allows to manipulate objects in the
112 viewer with the mouse and locked Ctrl button: increase or decrease the
113 zoom ratio with the left mouse button, translate object in any
114 direction with the central mouse button or rotate it with the right
116 - <b>Keyboard Free</b> - allows to manipulate objects in the viewer
117 with the mouse without locking Ctrl button. In this case the
118 operations are assigned to the buttons differently: rotation is made
119 with the left button, translation with the right and zoom with both
120 pressed in the same time.
121 - <b>Zooming style</b> - this option allows to choose a zooming mode.
122 - <b>Relative to the view's center</b> - allows to zoom the view
123 relatively to its center.
124 - <b>Relative to the cursor</b> - allows to zoom the view
125 relatively to the current cursor position.
126 - <b>Trihedron</b> - viewer trihedron settings:
127 - <b>Size</b> - size of the coordinate axes (global trihedron)
128 displayed in the viewer.
129 - <b>Relative</b> - if this option is switched on, trihedron
130 axes scale to fit the size of the scene displayed in 3D viewer.
131 - <b>Show static trihedron</b> - allows to show/hide the static
132 mini-trihedron located in the bottom-left corner of the viewer.
134 \anchor occ_preferences
135 <h2>OCC 3D Viewer Preferences</h2>
137 \image html pref_salome_occviewer.png
139 - <b>Background</b> - specifies the default background for the viewers,
140 separately for (for more details, refer to the \ref viewer_background
147 - <b>Enable preselection</b> - switches preselection on/off.
148 - <b>Enable selection</b> - switches selection on/off.
149 - <b>Clipping parameters</b> - specifies the default clipping plane parameters.
150 - <b>Color</b> - allows to change the color of the clipped region.
151 - <b>Use default texture</b> - if this option is switched on, the default texture
152 will be used for clipping texture, otherwise - the texture specified in "Texture" field.
153 - <b>Texture</b> - allows to change the texture of the clipped region (enable if "Use default texture" is switched off).
154 - <b>Modulate</b> - controls if "Texture" should be mixed with "Color" parameter or not.
155 - <b>Scale factor</b> - sets the scale factor for default and custom textures.
157 \anchor vtk_preferences
158 <h2>VTK 3D Viewer Preferences</h2>
160 \image html pref_salome_vtkviewer.png
162 - <b>Projection mode</b> - allows choosing between \b Orthogonal and
163 \b Perspective projection mode.
164 - <b>Background</b> - specifies the default background for the viewer;
165 for more details, refer to the \ref viewer_background "this page".
166 - <b>Speed Increment</b> - defines the number of units by
167 which the speed increases or respectively decreases after pressing [+]
168 or [-] keyboard buttons.
169 - <b>Modification Mode</b> - allows choosing between \b Arithmetic
170 and \b Geometrical progression used for zooming.
172 - <b>Preselection</b> - allows to choose among three possible preselection modes:
173 - <b>Standard</b> - this mode works quickly, by checking only
174 bounding boxes of objects. It does not deal with the order of actors in the view
175 or with their data (points/ cells).
176 - <b>Dynamic</b> - works directly with cells of actors, which provides the
177 exact area of preselection. This mode is much more slower.
178 - <b>Disabled</b> - switches off the preselection.
179 - <b>Enable selection</b> - switches selection on/off.
180 - <b>Spacemouse</b> - a mouse-like manipulator device specially designed
181 for working with 3D presentations, objects, etc. You can reassign the
182 actions listed below to any of its buttons.
183 - <b>Decrease Speed Increment</b> - decreases by 1 the speed
184 increment used for the keyboard (same as [-] key).
185 - <b>Increase Speed Increment</b> - increase by 1 the speed
186 increment used for the keyboard (same as [+] key).
187 - <b>Dominant / combined switch</b> - toggles button to switch to
188 dominant or combined movements.
189 - <b>AVI Recording</b>
190 - <b>Mode</b> - allows to choose from two recording regimes:
191 - <b>Recording all displayed frames</b> - records exactly at the
192 FPS rate specified by the user.
193 - <b>Recording at a given FPS</b> - records only when the contents
194 of the viewer change (some activity is performed). In the AVI file
195 non-recorded images are substituted with the copies of the latest
196 recorded image, which produces files with lower quality but requires
197 less system resources.
198 - <b>FPS</b> - allows to define the FPS (frames per second) rate for
199 the clip. Set greater value for better quality.
200 - <b>Quality</b> - allows to set the quality of the clip in the
201 interval between 0 and 100.
202 - <b>Progressive</b> - allows to record a progressive API file.
203 - <b>Names of groups</b> - allows to specify parameters of the
204 titles displayed in the viewer:
205 - <b>Text color</b> - allows selecting the text color;
206 - <b>Transparency</b> - allows selecting the text transparency.
208 \anchor plot2d_preferences
209 <h2>Plot 2D Viewer Preferences</h2>
211 \image html pref_salome_plot2dviewer.png
213 - <b>Background color</b> - this submenu allows to select the background
214 color. Click on the colored line to access to the
215 \ref select_color_and_font_page "Select Color" dialog box.
216 - <b>Selection color</b> - this submenu allows to select the color of
217 selected object in the viewer.
218 - <b>Viewer</b> - allows specifying the properties of the Plot 2D Viewer.
219 - <b>Curve Type</b> - this allows to set the representation of graphs in
220 your presentations. You can see only <b>Points</b>, points connected with
221 <b>Lines</b> or points connected with smooth <b>Splines</b>.
222 - <b>Marker Size</b> - this submenu allows you to set the size of
223 markers in your graphs.
224 - <b>Horizontal</b> and <b>Vertical axis scale</b> - this submenus allow you to set
225 the scale for vertical and horizontal axes. It can be either <b>Linear</b> or
226 <b>Logarithmic</b>. Note that the <b>Logarithmic</b> scale can be used only
227 if the minimum value of corresponding component (abscissa or ordinate)
228 of all points displayed in the viewer is greater than zero.
229 If this condition is not met, the scale is switched to <b>Linear</b>
230 automatically, even if it is set to <b>Logarithmic</b>.
231 - <b>Deviation marker color</b> - this submenu allows to select the
232 color of the deviation marker.
233 - <b>Deviation marker line width</b> allows to define line width of
234 the deviation marker.
235 - <b>Deviation marker tick size</b> allows to define size of the upper
236 and lower horizontal lines of the deviation marker.
237 - <b>Legend</b> - allows specifying the properties of the legend.
238 - <b>Show legend</b> - this options specifies if it's necessary to
239 show legend by default.
240 - <b>Legend Position</b> - this submenu allows to set the default position
241 of the legend, it can be located to the left, to the right, on top or
242 on bottom of the graph.
243 - <b>Symbol type</b> you can select the type of legend item symbol from "Marker on line"
244 or "Marker above line"
245 - <b>Legend font</b> - this allows to set type and face for the font of Legend item.
246 - <b>Legend font color</b> - this allows to select the color of the
247 font of the legend item.
248 - <b>Highlighted legend font color</b> - this submenu allows to select
249 the color of the font of the selected legend item.
251 \anchor default_python_preferences
252 <h2>Python Viewer Preferences</h2>
254 \image html pref_salome_pythonviewer.png
256 \note The following settings are default and will be applied only for newly created Python viewers. Customization of already opened viewers can be done using local \ref custom_python_preferences "Preferences dialog box" called by clicking on the corresponding icon of \ref python_viewer_page "Python viewer toolbar".
258 - <b>Font settings</b> allows setting font variant, size and style.
260 - <b>Display settings</b> specifies the script representation in the viewer:
262 - <b>Enable current line highlight</b> switches on background coloring of the current line.
263 - <b>Enable text wrapping</b> wraps lines at the view border of the editor.
265 - <b>Center cursor on scroll</b> scrolls the script vertically to make the cursor visible at the center of the viewer.
267 - <b>Display line numbers area</b> shows a panel with line numbers of the script at the left border of the editor.
269 - <b>Tab settings</b> allows displaying tab indentation as a certain number of white-spaces.
271 - <b>Vertical edge settings</b> manages drawing of a vertical line at the specified column of the viewer.
273 <h2>Directories Preferences</h2>
275 \image html pref_salome_directories.png
277 - <b>Quick Directory List</b> - this section allows to create and manage
278 a custom quick directory list. To add a directory in the list, press
279 the "Add directory" button:
280 \image html image70.png
281 then the "<b>...</b>" button and browse the data tree for the
283 The "Up" and "Down" buttons(see the picture below) help you to sort
284 the directories in the list:
285 \image html image73.png
286 \image html image75.png
287 To remove the selected directory from the list, press the "Delete"
289 \image html image72.png
291 <br><h2>Object Browser Preferences</h2>
293 \image html pref_salome_objbrowser.png
295 - <b>Search Tool</b> - specifies behavior of the
296 \ref using_find_tool_page "Search tool".
297 - <b>Enable auto-hiding</b> checkbox - hides the search tool
298 automatically after short perioud of time when it is not used.
299 - <b>Look and feel</b>
300 - <b>Auto size for “Name” column</b> - this checkbox enables automatic
301 resizing for the “Name” column.
302 - <b>Auto size for other columns</b> - this checkbox enables
303 automatic resizing for the other columns.
304 - <b>Resize columns on expand item</b> - this checkbox enables
305 resizing columns on expanding an object browser item.
306 - <b>Browse to the published object</b> - this combobox allows to enable
307 automatic browsing to the objects just published to the study (using GUI
308 dialogs only). It means that the object browser will be scrolled to the
309 published objects, make them visible if they are collapsed and select the
310 first of them. Three modes are allowed for activating this feature:
311 - <b>Never</b> - automatic browsing is disabled.
312 - <b>After Apply & Close only</b> - browsing is activated when the
313 dialog is accepted by <b>Apply & Close</b> or <b>Ok</b> buttons (or if
314 the objects are published without using a dialog, for example, by
315 clicking a context menu button) and not activated when the
316 <b>Apply</b> button is pressed and therefore the dialog remains visible.
317 - <b>Always</b> - automatic browsing is always enabled.
318 - <b>Default columns</b> - these checkboxes allow to display or hide <b>Value</b>,
319 <b>Entry</b>, <b>IOR</b> and <b>Reference entry</b> columns in the Object Browser.
321 <br><h2>Shortcuts Preferences</h2>
323 \image html pref_salome_shortcuts.png
325 - <b>Shortcuts settings</b> widget allows to define custom shortcuts for
326 various operations. To change keyboard sequence for a certain action - select the
327 action and press the custom keys combination.
330 \subpage select_color_and_font_page "Font and color preferences"
331 are most oftenly used types of user settings.
333 When you change settings (click \b OK or \b Apply button) each module
334 receives the notification about what preferences are changed. You can
335 also click \b Defaults button to restore default preferences or \b Close
336 button to quit the dialog box without any changes.
338 \b Import button allows loading specific user file containing
339 preferences from any location at the computer through a standard
342 \image html import.png
344 The preferences files usually have *.xml extension. Also,
345 preferences files automatically saved by the application (stored in the
346 ~/.config/salome directory) have no extension and by default start with
347 .SalomeApprc. followed by SALOME version number. Usually there is a
348 separate preferences file for each SALOME version in use. Preferences
349 are saved to the file in the end of the working session and restored
350 at the application start-up.
352 \note The preferences you set will be default preferences for all \b new
353 objects, but they are not retroactive and do not automatically apply
354 to the existing objects.