doc/salome/gui/input/salome_desktop.doc

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