doc/salome/gui/input/introduction_to_gui.doc

   1 /*!
   2
   3 \page introduction_to_gui_page Introduction to GUI
   4
   5 \image html view2.png
   6
   7 \n SALOME GUI is based on SUIT (Salome User Interface
   8 Toolkit) that proposes very flexible, powerful and safe mechanisms of
   9 interaction with SALOME tool components (both CORBA and standalone),
  10 resource management, viewers and selection handling,
  11 exception and signals processing. This approach brings to the top
  12 Salome multi-desktop dockable-windowed user interface.
  13 \n All Graphical User Interfaces of standard modules have plug-in
  14 structure, i.e. each module is placed in a dynamic library which is
  15 loaded on demand. So, all modules add their own menu items, buttons
  16 in toolbar, windows etc.
  17 \b GUI (Graphical User Interface) provides a common shell for all
  18 components, which can be integrated into the SALOME platform and some
  19 basic GUI functionalities, common for all modules.
  20
  21 \image html mainmenu.png
  22
  23 <ul>
  24 <li>\b File menu corresponds to \subpage study_management_page "Study management" functionalities
  25 (creation, saving, loading, editing studies, etc.).</li>
  26 <li>\b Edit menu gives access to <b> Copy/Paste</b> allowing to paste the
  27 objects from one study into the other. The availability of this
  28 functionality depends on the module and the nature of an operation or
  29 an object.</li>
  30 <li>\b View and \b Window menus provide functionalities of
  31 \subpage salome_desktop_page "Desktop management". Basically, they
  32 allow to show/hide toolbars, activate and manage study windows, change
  33 the appearance of Salome, etc. Among key parts of study window are:
  34
  35 <ul>
  36 <li>Viewer window, used for visualization of objects,</li>
  37 <li>\subpage using_object_browser_page "Object Browser", used for
  38 management of objects created or imported into the SALOME
  39 application, also providing search possibilities with the
  40 \subpage using_find_tool_page "Find Tool", and </li>
  41 <li>\subpage python_interpreter_page "Python interpreter", used for
  42 direct input of python commands and dumping studies into Python
  43 scripts. </li>
  44 <li> Almost all aspects of Salome look and feel can be tuned by the
  45 user in \subpage themes_page "Themes" dialog. </li>
  46 </ul>
  47 </li>
  48
  49 <li>\b Tools menu gives access to: \subpage using_catalog_generator_page "Catalogue Generator", and
  50 \subpage using_registry_tool_page "Registry tool"</li>
  51 <li>\b Help menu gives access to the help on Salome modules. The
  52 appropriate help page can also be called from any operation dialog via
  53 \b Help button.</li>
  54 </ul>
  55
  56 Help for the GUI module provides information about standard
  57 \subpage viewers_page "Salome Viewers":
  58 <ul>
  59 <li>\ref occ_3d_viewer_page "OCC 3D viewer", </li>
  60 <li>\ref vtk_3d_viewer_page "VTK 3D viewer" and </li>
  61 <li>\ref plot2d_viewer_page "Plot 2D viewer". </li>
  62 </ul>
  63
  64 \subpage setting_preferences_page "Preferences" for all Salome modules
  65 are also described in this section of Salome GUI Help.
  66
  67 */