doc/salome/gui/input/salome_desktop.doc

   1 /*!
   2
   3 \page salome_desktop_page SALOME desktop
   4
   5 <b>Multi-Desktop Approach</b> used in Salome means that there is a separate Desktop
   6 for each Study and all windows connected to one Study (viewers, dockable
   7 windows etc) are placed in one container.
   8 This approach positively differs from the classic multi document interface
   9 if many windows are used, i.e. when one document contains a lot of
  10 viewers, dialogs, etc. Each desktop also has its own menu and toolbar.
  11
  12 The main SALOME Desktop consists of the following sections and
  13 toolbars:
  14
  15 \image html geomview-alt.png
  16
  17
  18 <b>Basic parts of the SALOME Desktop:</b>
  19 <ul>
  20 <li><b>Main menu</b> - This is a set of context-sensitive menus, which will
  21 be updated according the functionality of the loaded component. In
  22 general,  these menus contain all functional options of SALOME
  23 platform.</li>
  24 <li><b>Standard Toolbar</b> - This toolbar contains icons allowing
  25 creating/saving studies, correcting mistakes, copying/pasting
  26 objects.</li>
  27 <li><b>Components Toolbar</b> - This toolbar is destined for uploading
  28 components in SALOME platform.</li>
  29 <li><b>Module Toolbar</b> - This toolbar contains icons specific to the
  30 loaded module.</li>
  31 <li><b>Viewer Toolbar</b> - This is a set of tools destined for visualization
  32 of the presentations in the viewer.</li>
  33 </ul>
  34
  35
  36 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;All toolbars in the
  37 \b SALOME Platform are context-sensitive. Loading of a definite component
  38 (Geometry, Post-Pro, Mesh etc.) will automatically add some additional
  39 toolbars specific to this component. To display/hide a definite
  40 toolbar, in the main menu choose <b>View > Toolbars</b>, and from this
  41 submenu check or uncheck the toolbar, you would like to display/hide.
  42
  43 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;By default all
  44 toolbars are located on the top of the SALOME desktop. But you can
  45 relocate toolbars by dragging with the mouse and dropping it in any
  46 place of the window.
  47
  48 <b>Parts of  the study window:</b>
  49 <ul>
  50 <li><b>Object Browser</b> - Management of objects created or imported into
  51 SALOME application.</li>
  52 <li>\b Viewer - This window is destined for visualization of
  53 presentations.</li>
  54 <li><b>Python console</b> - Window for Python interpreter. This window
  55 functions like a standard document: the pop-up menu invoked by
  56 right-click in this window gives access to
  57 <b>Copy/Paste/SelectAll/ClearAll</b> options.</li>
  58 </ul>
  59
  60 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Object Browser, Python
  61 Console, MenuBar, etc are, in fact, separate dockable windows.
  62 Dockable windows can be placed in special areas, on the borders of
  63 desktop like toolbars. You can change the size and the position of
  64 dockable windows, hide them or even place outside desktop. SALOME
  65 saves in the same file all positions and sizes of dockable windows. It
  66 means that the difference in settings of the same windows (for example
  67 Python console) is possible between different modules (the same window
  68 can have different size and position when other module is
  69 activated). Also each module can indicate which common windows are
  70 necessary for working, and only they will be displayed when this
  71 module is active.
  72
  73 All parts of Salome desktop and study window can be managed through \b
  74 View menu.
  75
  76 \image html viewmenu.png
  77
  78 <ul>
  79 <li>\b Toolbars - allows to show and hide toolbars</li>
  80 <li>\b Windows - allows to show and hide dockable windows, such as
  81 Object Browser and Python Console</li>
  82 <li><b> Status Bar </b> allows showing and hiding the Status Bar.</li>
  83 <li>\ref themes_page "Theme" - allows to select and edit the style (colors and fonts) for
  84 Salome session.</li>
  85 </ul>
  86
  87 If there are several viewer windows in your current study and
  88 you want to display more then one at the same time, you can use the
  89 functionalities provided by the \b Window menu.
  90
  91 \image html windowmenu.png
  92
  93 <ul>
  94 <li><b>New window </b> - allows to open a new instance of any
  95 viewer.</li>
  96 <li><b>Close</b> - closes the currently active viewer window.</li>
  97 <li><b>Close all</b> - closes all viewer windows.</li>
  98 <li><b>Group all</b> - arranges all created viewer windows on the same desktop</li>
  99 <li><b>Split Vertically</b> and <b>Split Horizontally</b> allows to split
 100 the representation area into two parts, in horizontal or vertical
 101 direction.</li>
 102 <li>List of all opened viewer windows provides fast access to
 103 them.</li>
 104 <li>\b Rename - allows to rename the currently selected viewer
 105 window. </li>
 106 </ul>
 107
 108
 109
 110 */