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