Salome HOME
Redesign SALOME documentation
[modules/gui.git] / doc / salome / gui / input / salome_desktop.rst
1 .. _salome_desktop_page:
2
3 **************
4 SALOME desktop
5 **************
6
7 SALOME applies **Single Document Interface** (SDI) approach. Only one 
8 :ref:`study_management_page` "study (document)" can be opened at any given moment.
9
10 The front-end of the application is a single Desktop top-level window
11 that embeds all GUI operations. The desktop window provides access to standard GUI elements,
12 such as viewers, main menu, toolbars, dockable windows, dialog boxes, etc. 
13
14 The main elements of the SALOME Desktop are represented on the picture below:
15
16 .. image:: ../images/desktop.png
17         :align: center
18
19 The main parts of the SALOME Desktop are:
20
21 * **Main menu** - This is a set of context-sensitive menus updated according to the functionality of the currently active component. In general, these menus contain all functional options of SALOME platform.
22 * **Standard toolbar** - contains standard actions that allow creating new or opening existing study, saving study, deleting objects, etc.
23 * **Components toolbar** - allows activating components in SALOME platform.
24 * **Module toolbars** - contain actions specific to the currently active module.
25 * **Viewer toolbar** - provides a set of tools destined for visualization of the presentations in the viewer.
26
27 All toolbars in the **SALOME** Platform are context-sensitive. Loading of a definite component
28 (Geometry, Mesh etc.) will automatically add some additional
29 toolbars specific to this component. To display/hide a toolbar, in the main menu choose **View > Toolbars**, and from this submenu check or uncheck the toolbar that you would like to display/hide.
30
31 By default all toolbars are located on top of the SALOME desktop, but you can relocate a toolbar by dragging it with the mouse and dropping in any place of the window.
32
33 Parts of the study window:
34
35 * **Object browser** - Management of objects created or imported into SALOME application.
36 * **Viewer** - This window is destined for visualization of presentations.
37 * **Python console** - Window for Python interpreter. This window functions like a standard document: the pop-up menu invoked by right-click in this window gives access to **Copy/Paste/SelectAll/ClearAll** options.
38
39 Object Browser, Python Console, MenuBar, etc are, in fact, separate dockable windows.
40 Dockable windows can be placed in special areas, on the borders of
41 desktop like toolbars. You can change the size and the position of
42 dockable windows, hide them or even place outside desktop. SALOME
43 saves in the same file all positions and sizes of dockable windows. It
44 means that the difference in settings of the same windows (for example
45 Python console) is possible between different modules (the same window
46 can have different size and position when other module is
47 activated). Also each module can indicate which common windows are
48 necessary for working, and only they will be displayed when this
49 module is active.
50
51 All parts of Salome desktop and study window can be managed through **View** menu.
52
53 .. image:: ../images/viewmenu.png
54         :align: center
55
56 - **Toolbars** - allows to show and hide toolbars.
57 - **Windows** - allows to show and hide dockable windows, such as Object Browser and Python Console.
58 - **Status Bar** allows showing and hiding the Status Bar.
59 - :ref:`themes_page` - allows to select and edit the style (colors and fonts) for Salome session.
60
61 If there are several viewer windows in your current study and you want to display more then one at the same time, you can use the functionalities provided by the **Window** menu.
62
63 .. image:: ../images/windowmenu.png
64         :align: center
65
66 - **New window** - allows to open a new instance of any viewer.
67 - **Close** - closes the currently active viewer window.
68 - **Close all** - closes all viewer windows.
69 - **Group all** - arranges all created viewer windows on the same desktop.
70 - **Arrange Views** - allows choosing the necessary views and their layout (see image below).
71
72   - The radio-buttons in **Views Layout** section allow choosing the number of views to be arranged (2, 3 or 4). The buttons with images allow choosing the view layout (depending on the chosen number of views). 
73   - **Views List**  contains the list of opened view windows, where it is possible to check in the necessary views. 
74   - **Close the remaining views** check-box allows closing all non-selected views.    
75   - **Stack the remaining views** check-box allows stacking all non-selected views in the last tab area.
76
77 .. image:: ../images/arrange_views_dlg.png
78         :align: center
79
80 - **Split Vertically** and **Split Horizontally** allow splitting the representation area into two parts, in horizontal or vertical direction.
81 - List of all opened viewer windows provides fast access to them.
82 - **Rename** - allows renaming the currently selected viewer window.
83
84