[modules/gui.git] / doc / salome / gui / input / salome_preferences.doc

/*!

\page salome_preferences_page SALOME preferences

To begin setting preferences for your study, select \b Preferences in the
main menu, the following dialog box will appear:

\image html pref11.png
If you've just started your study and haven't yet loaded other
modules, you'll be able to change only those settings, which refer to
the whole GUI SALOME session. These settings will be valid for the
whole study session.

<h2>General Preferences</h2>

<ul>
<li><b>Study Properties</b></li>
<ul>
<li><b>MultiFile Save</b> - if checked in, your study will be saved in
several HDF files (one basic HDF file which will store the main
information about the saved study and several other files for the data created by each component
used during the study session). Opening of this study
requires that \b ALL saved files should be stored in the \b SAME directory.
If you would like to copy your saved study in another directory or
machine, you should copy all stored files. Otherwise, if you try to
open this study, some data will be lost and it will lead to invalid
functioning of the SALOME platform.</li>
<li><b>ASCII Save</b> - if checked in, your study will be saved in
ASCII format file (or files).</li>
<li><b>Store positions of windows</b> -  if checked in, positions of windows
will be saved in a special file at the end of the current session and
then restored for a new session.</li>
<li><b>Store/restore last GUI state</b> - if checked in, all GUI settings are
saved with the rest of the data whenever you save the study. When the
study is reopened, the GUI state is restored.</li>
</ul>
<li><b>External browser</b></li>
<ul>
<li>\b Application - this option allows you to set an external browser (IE,
Netscape) which will be used for viewing SALOME reference manuals. By
default, Mozilla is used. Press the &quot;<b>...</b>&quot; button(see
the picture below) to browse for the application you need in the data
tree of your computer.</li>
<li>\b Parameters</li>
</ul>
<li><b>Python console properties</b> - here you can quickly set the
parameters (style, size, face) of the font used in your Python
console.</li>
<li><b>Show MRU items</b> - allows to define the maximum \b Number of
items in <b>Most Recently Used</b> list and the <b>Link type</b>: 
<ul>
<li>\b Long - shows the full path to the file. </li>
<li>\b Short - shows the file name only. </li>
<li>\b Auto - shows full paths to the files only if some files from
different locations have the same name. </li>
</ul>
</li>  
</ul>
\par
For detailed settings in \ref select_color_and_font_page "Select Font"
dialog box press the &quot;<b>...</b>&quot; button(see the picture below).

\image html image69.gif "&quot;...&quot; button"

<br><h2>Viewers Preferences</h2>

\image html pref12.png

<ul>
<li><b>OCC and VTK 3D Viewers</b></li>
<ul>
<li><b>Trihedron size</b> - this submenu allows to set the size of
coordinate axes displayed in the viewer.</li>
<li><b>Background Color</b> - this submenu allows to select background
color. Click on the colored line to access to the 
\ref select_color_and_font_page "Select Color" dialog box.</li>
<li><b>Number of isolines along U</b> (or <b>V</b>) - this submenu allows to specify
the number of isolines along the axes of coordinates.</li>
<li><b>Relative size</b> - if checked in, trihedron axes scale to fit the
size of the area displayed in 3D Viewer.</li>
<li><b>Projection mode</b> - allows choosing between \b Orthogonal and
\b Perspective projection mode. </b>
<li><b>Navigation mode</b> - this option allows to choose one of the
modes of work with mouse in VTK viewer.</li>
<ul>
<li><b>Salome Standard Controls</b> - allows to manipulate objects in the
viewer with the mouse and locked Ctrl button: increase or decrease the
zoom ratio with the left mouse button, translate object in any
direction with the central mouse button or rotate it with the right
mouse button.</li>
<li><b>Keyboard Free</b> - allows to manipulate objects in the viewer
with the mouse without locking Ctrl button. In this case the
operations are assigned to the buttons differently: rotation is made
with the left button, translation with the right and zoom with both
pressed in the same time.</li>
</ul>
<li><b>[+]/[-] Speed Increment</b> - defines the number of units by
which the speed increases or respectively decreases after pressing [+]
or [-] keyboard buttons.</li>
<li><b>Modification Mode</b> - allows choosing between \b Arithmetic
and \b Geometrical progression used for zooming</li> 
</ul>
<li><b>Spacemouse</b> - a mouse-like manipulator device specially designed
for working with 3D presentations, objects, etc. You can reassign the
actions listed below to any of its buttons.</li>
<ul>
<li><b>Decrease Speed Increment</b> - decreases by 1 the speed increment used for the keyboard (same as [-] key).</li>
<li><b>Increase Speed Increment</b> - increase by 1 the speed increment used for the keyboard (same as [+] key).</li>
<li><b>Dominant / combined switch</b> - toggles button to switch to dominant or combined movements.</li>
</ul>
<li><b>AVI Recording</b></li>
<ul>
<li><b>Mode</b> - allows to choose from two recording regimes:</li>
<ul>
<li><b>Recording all displayed frames</b> - records exactly at the FPS rate specified by the user.</li>
<li><b>Recording at a given FPS</b> - records only when the contents
of the viewer change (some activity is performed).  In the AVI file
non-recorded images are substituted with the copies of the latest
recorded image, which produces files with lower quality but requires
less system resources.   </li>
</ul>
<li><b>FPS</b> - allows to define the FPS (frames per second) rate for
the clip. Set greater value for better quality.</li>
<li><b>Quality</b> - allows to set the quality of the clip in the
interval between 0 and 100.</li>
<li><b>Progressive</b> - allows to record a progressive API
file.</li>
</ul>

<br>
<li><b>Plot2d Viewer</b></li>
<ul>
<li><b>Legend Position</b> - this submenu allows to set the default position
of the legend, it can be located to the left, to the right, on top or
on bottom of the graph.</li>
<li><b>Curve Type</b> - this allows to set the representation of graphs in
your presentations. You can see only <b>Points</b>, points connected with
<b>Lines</b> or points connected with smooth <b>Splines</b>.</li>
<li><b>Marker Size</b> - this submenu allows you to set the size of
markers in your graphs</li>
<li><b>Horizontal & Vertical Axis Scale</b> - this submenu allows you to set
the scale for vertical and horizontal axes. It can be either <b>Linear</b> or
<b>Logarithmic</b></li>
<li>Background Color - this submenu allows to select the background
color. Click on the colored line to access to the 
\ref select_color_and_font_page "Select Color" dialog box.</li>
</ul>
<br>
<li><b>Graph Supervisor</b></li>
<ul>
<li><b>Background Color</b> - this submenu allows to select background
color. Click on the colored line to access to the 
\ref select_color_and_font_page "Select Color" dialog box.</li>
<li><b>Title Color</b> - this submenu allows to select title color. Click on
the colored line to access to the 
\ref select_color_and_font_page "Select Color" dialog box.</li>
</ul>
</ul>

<br><h2>Directories Preferences</h2>

\image html pref13.png

<ul>
<li>
<b>Quick Directory List</b> - this section allows to create and manage
a custom quick directory list. To add a directory in the list, press
the "Add directory" button:
\image html image70.gif

then the &quot;<b>...</b>&quot; button and browse the data tree for the
directory you need.
The "Up" and "Down" buttons(see the picture below) help you to sort
the directories in the list:
\image html image73.gif

\image html image75.gif
To remove the selected directory from the list, press the "Delete"
button:
\image html image72.png
</li>
</ul>

<br><h2>Object Browser Preferences</h2>

\image html pref14.png

<ul>
<li><b>Enable auto-hiding</b> checkbox - hides the 
\ref using_find_tool_page if nor used</li>
<li><b>Object browser settings</b></li>
<ul>
<li><b>Auto size for the first column</b> - this checkbox enables automatic
resizing for the first column.</li>
<li><b>Auto size for other columns</b> - this checkbox enables
automatic resizing for the other columns.</li>
<li><b>Resize columns after expanding an item</b> - this checkbox enables
resizing columns on expanding an object browser item.</li>
</ul>
</ul>

<ul>
<li><b>Default columns</b> - these checkboxes allow to display or hide <b>Value</b>,
<b>Entry</b>, <b>IOR</b> and <b>Reference entry</b> columns in the Object Browser.</li>
</ul>

*/