Salome HOME
Merge branch 'V8_4_BR'
[modules/gui.git] / doc / salome / gui / input / salome_desktop.doc
index f6361c6206a82c78d5219d68eae77f2bc447b70b..2eb5ffd460e61f61ad83f789c4c68f97c99c3889 100644 (file)
@@ -2,63 +2,48 @@
 
 \page salome_desktop_page SALOME desktop
 
-<b>Multi-Desktop Approach</b> used in Salome means that there is a separate Desktop
-for each Study and all windows connected to one Study (viewers, dockable
-windows etc) are placed in one container. 
-This approach positively differs from the classic multi document interface 
-if many windows are used, i.e. when one document contains a lot of
-viewers, dialogs, etc. Each desktop also has its own menu and toolbar.
-
-The main SALOME Desktop consists of the following sections and
-toolbars:
-
-\image html geomview-alt.png
-
-
-<b>Basic parts of the SALOME Desktop:</b>
-<ul>
-<li><b>Main menu</b> - This is a set of context-sensitive menus, which will
-be updated according the functionality of the loaded component. In
-general,  these menus contain all functional options of SALOME
-platform.</li>
-<li><b>Standard Toolbar</b> - This toolbar contains icons allowing
-creating/saving studies, correcting mistakes, copying/pasting
-objects.</li>
-<li><b>Components Toolbar</b> - This toolbar is destined for uploading
-components in SALOME platform.</li>
-<li><b>Module Toolbar</b> - This toolbar contains icons specific to the
-loaded module.</li>
-<li><b>Viewer Toolbar</b> - This is a set of tools destined for visualization
-of the presentations in the viewer.</li>
-</ul>
-
-
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;All toolbars in the
-\b SALOME Platform are context-sensitive. Loading of a definite component
-(Geometry, Post-Pro, Mesh etc.) will automatically add some additional
-toolbars specific to this component. To display/hide a definite
-toolbar, in the main menu choose <b>View > Toolbars</b>, and from this
-submenu check or uncheck the toolbar, you would like to display/hide.
-
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;By default all
-toolbars are located on the top of the SALOME desktop. But you can
-relocate toolbars by dragging with the mouse and dropping it in any
-place of the window.
-
-<b>Parts of  the study window:</b>
-<ul>
-<li><b>Object Browser</b> - Management of objects created or imported into
-SALOME application.</li>
-<li>\b Viewer - This window is destined for visualization of
-presentations.</li>
-<li><b>Python console</b> - Window for Python interpreter. This window
+SALOME applies <b>Single Document Interface</b> (SDI) approach. Only one 
+\ref study_management_page "study (document)" can be opened at any given moment.
+
+The front-end of the application is a single Desktop top-level window
+that embeds all GUI operations. The desktop window provides access to standard GUI elements,
+such as viewers, main menu, toolbars, dockable windows, dialog boxes, etc. 
+
+The main elements of the SALOME Desktop are represented on the picture below:
+
+\image html desktop.png
+
+The main parts of the SALOME Desktop are:
+- <b>Main menu</b> - 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.
+- <b>Standard toolbar</b> - contains standard actions
+that allow creating new or opening existing study, saving study, deleting
+objects, etc.
+- <b>Components toolbar</b> - allows activating
+components in SALOME platform.
+- <b>Module toolbars</b> - contain actions specific to the
+currently active module.
+- <b>Viewer toolbar</b> - provides a set of tools destined for visualization
+of the presentations in the viewer.
+
+All toolbars in the \b SALOME Platform are context-sensitive. Loading of a definite component
+(Geometry, Mesh etc.) will automatically add some additional
+toolbars specific to this component. To display/hide a toolbar, in the main menu choose <b>View > Toolbars</b>, and from this submenu check or uncheck the toolbar that you would like to display/hide.
+
+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.
+
+Parts of the study window:
+- <b>Object browser</b> - Management of objects created or imported into
+SALOME application.
+- \b Viewer - This window is destined for visualization of
+presentations.
+- <b>Python console</b> - 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
-<b>Copy/Paste/SelectAll/ClearAll</b> options.</li>
-</ul>
+<b>Copy/Paste/SelectAll/ClearAll</b> options.
 
-&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Object Browser, Python
-Console, MenuBar, etc are, in fact, separate dockable windows.
+Object Browser, Python Console, MenuBar, etc are, in fact, separate dockable windows.
 Dockable windows can be placed in special areas, on the borders of
 desktop like toolbars. You can change the size and the position of
 dockable windows, hide them or even place outside desktop. SALOME
@@ -70,41 +55,35 @@ activated). Also each module can indicate which common windows are
 necessary for working, and only they will be displayed when this
 module is active.
 
-All parts of Salome desktop and study window can be managed through \b
-View menu.
+All parts of Salome desktop and study window can be managed through \b View menu.
 
 \image html viewmenu.png
 
-<ul>
-<li>\b Toolbars - allows to show and hide toolbars</li>
-<li>\b Windows - allows to show and hide dockable windows, such as
-Object Browser and Python Console</li>
-<li><b> Status Bar </b> allows showing and hiding the Status Bar.</li>
-<li>\ref themes_page "Theme" - allows to select and edit the style (colors and fonts) for
-Salome session.</li>
-</ul>
+- \b Toolbars - allows to show and hide toolbars.
+- \b Windows - allows to show and hide dockable windows, such as
+Object Browser and Python Console.
+- <b> Status Bar </b> allows showing and hiding the Status Bar.
+- \ref themes_page "Theme" - allows to select and edit the style (colors and fonts) for Salome session.
 
-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 \b Window menu.
+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 \b Window menu.
 
 \image html windowmenu.png
 
-<ul>
-<li><b>New window </b> - allows to open a new instance of any
-viewer.</li> 
-<li><b>Close</b> - closes the currently active viewer window.</li> 
-<li><b>Close all</b> - closes all viewer windows.</li>
-<li><b>Group all</b> - arranges all created viewer windows on the same desktop</li>
-<li><b>Split Vertically</b> and <b>Split Horizontally</b> allows to split
-the representation area into two parts, in horizontal or vertical
-direction.</li>
-<li>List of all opened viewer windows provides fast access to
-them.</li>
-<li>\b Rename - allows to rename the currently selected viewer
-window. </li>
-</ul>
+- <b>New window </b> - allows to open a new instance of any viewer.
+- <b>Close</b> - closes the currently active viewer window.
+- <b>Close all</b> - closes all viewer windows.
+- <b>Group all</b> - arranges all created viewer windows on the same desktop.
+- <b>Arrange Views</b> - allows choosing the necessary views and their layout (see image below).
+  - The radio-buttons in <b>Views Layout</b> 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). 
+  - <b>Views List</b>  contains the list of opened view windows, where it is possible to check in the necessary views. 
+  - <b>Close the remaining views</b> check-box allows closing all non-selected views.    
+  - <b>Stack the remaining views</b> check-box allows stacking all non-selected views in the last tab area.
 
+\image html arrange_views_dlg.png
 
+- <b>Split Vertically</b> and <b>Split Horizontally</b> allow splitting 
+the representation area into two parts, in horizontal or vertical direction.
+- List of all opened viewer windows provides fast access to them.
+- \b Rename - allows renaming the currently selected viewer window.
 
-*/
\ No newline at end of file
+*/