Salome HOME
Regular pre-release documentation checking.
[modules/gui.git] / doc / salome / gui / input / setting_preferences.doc
1 /*!
2
3 \page setting_preferences_page Setting Preferences
4
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.
8
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.
16
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. 
20
21 More detailed information about preferences for certain modules can be found in the User's guide of the corresponding module.
22
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.
26
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. 
30
31 <h2>General Preferences</h2>
32
33 \image html pref_salome_general.png
34
35 - <b>Language</b>
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
59     the SALOME platform. 
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.
104 - <b>Full-screen</b> 
105   - <b>Hide object browser and viewers toolbars</b> - switches automatic hiding of 
106   Object Browser and OCC viewer toolbar in full-screen mode.
107
108 <h2>3D Viewer Preferences</h2>
109
110 \image html pref_salome_3dviewer.png
111
112 - <b>Navigation style</b> - this option allows to choose one of the
113   modes of work with mouse in OCC and VTK 3D viewers.
114   - <b>Salome Standard Controls</b> - allows to manipulate objects in the
115   viewer with the mouse and locked Ctrl button: increase or decrease the
116   zoom ratio with the left mouse button, translate object in any
117   direction with the central mouse button or rotate it with the right
118   mouse button.
119   - <b>Keyboard Free</b> - allows to manipulate objects in the viewer
120   with the mouse without locking Ctrl button. In this case the
121   operations are assigned to the buttons differently: rotation is made
122   with the left button, translation with the right and zoom with both
123   pressed in the same time.
124 - <b>Zooming style</b> - this option allows to choose a zooming mode.
125   - <b>Relative to the view's center</b> - allows to zoom the view 
126   relatively to its center.
127   - <b>Relative to the cursor</b> - allows to zoom the view
128   relatively to the current cursor position.
129 - <b>Trihedron</b> - viewer trihedron settings:
130   - <b>Size</b> - size of the coordinate axes (global trihedron)
131     displayed in the viewer.
132   - <b>Relative</b> - if this option is switched on, trihedron
133     axes scale to fit the size of the scene displayed in 3D viewer.
134   - <b>Show static trihedron</b> - allows to show/hide the static
135     mini-trihedron located in the bottom-left corner of the viewer.
136
137 \anchor occ_preferences
138 <h2>OCC 3D Viewer Preferences</h2>
139
140 \image html pref_salome_occviewer.png
141
142 - <b>Projection mode</b> - sets the default projection mode for the viewers: Orthogonal or Perpective.
143 - <b>Stereo render</b> - stereoscopic view settings:
144   - <b>Stereo type</b> - specifies a stereo pair type:
145     - Shutter glasses (OpenGL quad-buffer)
146     - Anaglyph
147     - Row-interlaced
148     - Column-interlaced
149     - Chess-board stereo for DLP TVs
150     - Horizontal-anamorphic (side-by-side)
151     - Vertical-anamorphic (Half OverUnder)
152     \note The stereo pair type selected in this combobox is applied 
153     for all existing OCC 3D views with stereo rendering already turned on 
154     within the same SALOME GUI session. It is not possible to use 
155     different stereo modes in several OCC 3D views at the same time 
156     within the same SALOME GUI session.
157   - <b>Anaglyph filter</b> - specifies the format of anaglyph stereo pair:
158     - Red-Cyan (default)
159     - Yellow-Blue
160     - Green-Magenta
161   - <b>Convergence distance type</b>: Absolute or Relative (default).
162   - <b>Stereographic focus value</b> - 1 by default.
163   - <b>IOD type</b> - Absolute or Relative (default).
164   - <b>Interocular distance (IOD) value</b> - 0.05 by default.
165   - <b>Reverse stereo</b> - option to swap left and right frames.
166   - <b>Enable V-Sync</b> - activates vertical synchronization.
167   - <b>Enable quad-buffer support</b> - allows quad-buffered rendering.
168   \note It is neccessary to enable quad-buffered stereoscopic rendering 
169   manually in graphic driver settings. SALOME does not do it automatically.
170   \note All existing OCC 3D views should be re-created for quad-buffer support.
171
172 - <b>Background</b> - specifies the default background for the viewers,
173   separately for (for more details, refer to the \ref viewer_background
174   "this page"):
175   - <b>3D View</b>
176   - <b>XZ View</b>
177   - <b>YZ View</b>
178   - <b>XY View</b>
179 - <b>Selection</b>
180   - <b>Enable preselection</b> - switches preselection on/off.
181   - <b>Enable selection</b> - switches selection on/off.
182 - <b>Clipping parameters</b> - specifies the default clipping plane parameters.
183   - <b>Color</b> - allows to change the color of the clipped region.
184   - <b>Use default texture</b> - if this option is switched on, the default texture
185     will be used for clipping texture, otherwise - the texture specified in "Texture" field.
186   - <b>Texture</b> - allows to change the texture of the clipped region (enable if "Use default texture" is switched off).
187   - <b>Modulate</b> - controls if "Texture" should be mixed with "Color" parameter or not.
188   - <b>Scale factor</b> - sets the scale factor for default and custom textures.
189
190 \anchor vtk_preferences
191 <h2>VTK 3D Viewer Preferences</h2>
192
193 \image html pref_salome_vtkviewer.png
194
195 - <b>Projection mode</b> - allows choosing between \b Orthogonal and
196 \b Perspective projection mode.
197 - <b>Background</b> - specifies the default background for the viewer;
198   for more details, refer to the \ref viewer_background "this page".
199 - <b>Speed Increment</b> - defines the number of units by
200   which the speed increases or respectively decreases after pressing [+]
201   or [-] keyboard buttons.
202 - <b>Modification Mode</b> - allows choosing between \b Arithmetic
203   and \b Geometrical progression used for zooming.
204 - <b>Stereo render</b> - stereoscopic view settings:
205   - <b>Stereo type</b> - specifies a stereo pair type:
206     - Crystal Eyes
207     - Red-Blue
208     - Interlaced
209     - Left
210     - Right
211     - Dresden
212     - Anaglyph
213     - Checkerboard
214     - Split View Port Horizontal
215     \note The stereo pair type selected in this combobox is applied 
216     for all existing VTK 3D views with stereo rendering already turned on 
217     within the same SALOME GUI session. It is not possible to use 
218     different stereo modes in several VTK 3D views at the same time 
219     within the same SALOME GUI session.
220   - <b>Anaglyph filter</b> - specifies the format of anaglyph stereo pair:
221     - Red-Cyan (default)
222     - Yellow-Blue
223     - Green-Magenta
224   - <b>Enable quad-buffer support</b> - allows quad-buffered rendering.
225   \note It is neccessary to enable quad-buffered stereoscopic rendering 
226   manually in graphic driver settings. SALOME does not do it automatically.
227   \note All existing VTK 3D views should be re-created for quad-buffer support.
228 - <b>Selection</b>
229   - <b>Preselection</b> - allows to choose among three possible preselection modes:
230     - <b>Standard</b> - this mode works quickly, by checking only 
231     bounding boxes of objects. It does not deal with the order of actors in the view 
232     or with their data (points/ cells).
233     - <b>Dynamic</b> - works directly with cells of actors, which provides the 
234     exact area of preselection. This mode is much more slower. 
235     - <b>Disabled</b> - switches off the preselection.
236   - <b>Enable selection</b> - switches selection on/off.
237 - <b>Spacemouse</b> - a mouse-like manipulator device specially designed
238   for working with 3D presentations, objects, etc. You can reassign the
239   actions listed below to any of its buttons.
240   - <b>Decrease Speed Increment</b> - decreases by 1 the speed
241   increment used for the keyboard (same as [-] key).
242   - <b>Increase Speed Increment</b> - increase by 1 the speed
243   increment used for the keyboard (same as [+] key).
244   - <b>Dominant / combined switch</b> - toggles button to switch to
245   dominant or combined movements. 
246 - <b>AVI Recording</b>
247   - <b>Mode</b> - allows to choose from two recording regimes:
248     - <b>Recording all displayed frames</b> - records exactly at the
249     FPS rate specified by the user. 
250     - <b>Recording at a given FPS</b> - records only when the contents
251     of the viewer change (some activity is performed).  In the AVI file
252     non-recorded images are substituted with the copies of the latest
253     recorded image, which produces files with lower quality but requires
254     less system resources.
255   - <b>FPS</b> - allows to define the FPS (frames per second) rate for
256   the clip. Set greater value for better quality.
257   - <b>Quality</b> - allows to set the quality of the clip in the
258   interval between 0 and 100.
259   - <b>Progressive</b> - allows to record a progressive API file.
260 - <b>Names of groups</b> - allows to specify parameters of the
261 titles displayed in the viewer:
262   - <b>Text color</b> - allows selecting the text color;
263   - <b>Transparency</b> - allows selecting the text transparency.
264
265 \anchor plot2d_preferences
266 <h2>Plot 2D Viewer Preferences</h2>
267
268 \image html pref_salome_plot2dviewer.png
269
270 - <b>Background color</b> - this submenu allows to select the background
271 color. Click on the colored line to access to the
272 \ref select_color_and_font_page "Select Color" dialog box.
273 - <b>Selection color</b> - this submenu allows to select the color of
274 selected object in the viewer. 
275 - <b>Viewer</b> - allows specifying the properties of the Plot 2D Viewer.
276   - <b>Curve Type</b> - this allows to set the representation of graphs in
277   your presentations. You can see only <b>Points</b>, points connected with
278   <b>Lines</b> or points connected with smooth <b>Splines</b>.
279   - <b>Marker Size</b> - this submenu allows you to set the size of
280   markers in your graphs.
281   - <b>Horizontal</b> and <b>Vertical axis scale</b> - this submenus allow you to set
282   the scale for vertical and horizontal axes. It can be either <b>Linear</b> or
283   <b>Logarithmic</b>. Note that the <b>Logarithmic</b> scale can be used only
284   if the minimum value of corresponding component (abscissa or ordinate)
285   of all points displayed in the viewer is greater than zero.
286   If this condition is not met, the scale is switched to <b>Linear</b>
287   automatically, even if it is set to <b>Logarithmic</b>.
288   - <b>Deviation marker color</b> - this submenu allows to select the
289   color of the deviation marker. 
290   - <b>Deviation marker line width</b> allows to define line width of
291   the deviation marker. 
292   - <b>Deviation marker tick size</b> allows to define size of the upper
293   and lower horizontal lines of the deviation marker. 
294 - <b>Legend</b> - allows specifying the properties of the legend.
295   - <b>Show legend</b> - this options specifies if it's necessary to
296   show legend by default.
297   - <b>Legend Position</b> - this submenu allows to set the default position
298   of the legend, it can be located to the left, to the right, on top or
299   on bottom of the graph.
300   - <b>Symbol type</b> you can select the type of legend item symbol from "Marker on line" 
301   or "Marker above line"
302   - <b>Legend font</b> - this allows to set type and face for the font of Legend item.
303   - <b>Legend font color</b> - this allows to select the color of the
304   font of the legend item. 
305   - <b>Highlighted legend font color</b> - this submenu allows to select
306   the color of the font of the selected legend item. 
307
308 \anchor default_python_preferences
309 <h2>Python Viewer Preferences</h2>
310
311 \image html pref_salome_pythonviewer.png
312
313 \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".
314
315 - <b>Font settings</b> allows setting font variant, size and style.
316   
317 - <b>Display settings</b> specifies the script representation in the viewer:
318
319   - <b>Enable current line highlight</b> switches on background coloring of the current line.
320   - <b>Enable text wrapping</b> wraps lines at the view border of the editor.
321
322   - <b>Center cursor on scroll</b> scrolls the script vertically to make the cursor visible at the center of the viewer.
323
324   - <b>Display line numbers area</b> shows a panel with line numbers of the script at the left border of the editor.
325
326 - <b>Tab settings</b> allows displaying tab indentation as a certain number of white-spaces.
327
328 - <b>Vertical edge settings</b> manages drawing of a vertical line at the specified column of the viewer.
329
330 <h2>Directories Preferences</h2>
331
332 \image html pref_salome_directories.png
333
334 - <b>Quick Directory List</b> - this section allows to create and manage
335 a custom quick directory list. To add a directory in the list, press
336 the "Add directory" button:
337 \image html image70.png
338 then the &quot;<b>...</b>&quot; button and browse the data tree for the
339 directory you need.
340 The "Up" and "Down" buttons(see the picture below) help you to sort
341 the directories in the list:
342 \image html image73.png
343 \image html image75.png
344 To remove the selected directory from the list, press the "Delete"
345 button:
346 \image html image72.png
347
348 <br><h2>Object Browser Preferences</h2>
349
350 \image html pref_salome_objbrowser.png
351
352 - <b>Search Tool</b> - specifies behavior of the
353 \ref using_find_tool_page "Search tool".
354   - <b>Enable auto-hiding</b> checkbox - hides the search tool
355   automatically after short perioud of time when it is not used.
356 - <b>Look and feel</b>
357   - <b>Auto size for “Name” column</b> - this checkbox enables automatic
358   resizing for the “Name” column.
359   - <b>Auto size for other columns</b> - this checkbox enables
360   automatic resizing for the other columns.
361   - <b>Resize columns on expand item</b> - this checkbox enables
362   resizing columns on expanding an object browser item.
363   - <b>Browse to the published object</b> - this combobox allows to enable
364   automatic browsing to the objects just published to the study (using GUI
365   dialogs only). It means that the object browser will be scrolled to the
366   published objects, make them visible if they are collapsed and select the
367   first of them. Three modes are allowed for activating this feature:
368     - <b>Never</b> - automatic browsing is disabled.
369     - <b>After Apply & Close only</b> - browsing is activated when the
370     dialog is accepted by <b>Apply & Close</b> or <b>Ok</b> buttons (or if
371     the objects are published without using a dialog, for example, by
372     clicking a context menu button) and not activated when the
373     <b>Apply</b> button is pressed and therefore the dialog remains visible.
374     - <b>Always</b> - automatic browsing is always enabled.
375 - <b>Default columns</b> - these checkboxes allow to display or hide <b>Value</b>,
376 <b>Entry</b>, <b>IOR</b> and <b>Reference entry</b> columns in the Object Browser.
377
378 <br><h2>Shortcuts Preferences</h2>
379
380 \image html pref_salome_shortcuts.png
381
382 - <b>Shortcuts settings</b> widget allows to define custom shortcuts for
383 various operations. To change keyboard sequence for a certain action - select the
384 action and press the custom keys combination.
385
386
387 \subpage select_color_and_font_page "Font and color preferences"
388 are most oftenly used types of user settings.
389
390 When you change settings (click \b OK or \b Apply button) each module
391 receives the notification about what preferences are changed. You can
392 also click \b Defaults button to restore default preferences or \b Close
393 button to quit the dialog box without any changes. 
394
395 \b Import button allows loading specific user file containing
396 preferences from any location at the computer through a standard
397 Import dialog box.
398
399 \image html import.png
400
401 The preferences files usually have *.xml extension. Also,
402 preferences files automatically saved by the application (stored in the
403 ~/.config/salome directory) have no extension and by default start with
404 .SalomeApprc. followed by SALOME version number. Usually there is a
405 separate preferences file for each SALOME version in use. Preferences
406 are saved to the file in the end of the working session and restored
407 at the application start-up.
408
409 \note The preferences you set will be default preferences for all \b new
410 objects, but they are not retroactive and do not automatically apply
411 to the existing objects.
412
413 */