doc/gui.rst

   1 .. _gui:
   2
   3 *******************************************************
   4 Using YACS with the graphical user interface (GUI)
   5 *******************************************************
   6
   7 YACS GUI description
   8 ====================
   9
  10 .. _mainwindow:
  11
  12 .. image:: images/yacs_gui_description_0.png
  13   :align: center
  14
  15 .. centered::
  16   Main Window
  17
  18 The YACS GUI document contains several 2D and tree views, one of each per run of a schema. There are different view modes of the schema.
  19 The SALOME Object browser is only used to publish the run of the schema as a whole, and under the run,
  20 the outputs of the run that are published for the use of other SALOME modules. During the schema design (edition),
  21 a dedicated edition tree view of the YACS data structure is used for schema building.
  22 Modifications are displayed on the 2D view.
  23
  24 Several executions (run) of the same schema can occur at the same time. Dedicated tree in run mode and 2D views are used for each run.
  25 The run tree view is used to control the execution (stop, breakpoints) and the 2D view reflects the detailed current state of execution.
  26
  27 The Python Console and Log Window often present in other SALOME modules are not used in YACS, so, they are not present by default.
  28
  29 For the quick access to basic operations the system of context-dependent popup menu is supported.
  30 Popup menu is called by click of the right button of the mouse on the selected object.
  31
  32 Drag and drop operations are often used in edition, between tree items and/or 2D items, for associations (link creation, for instance).
  33
  34 The main window look & feel is presented schematically below.
  35 Note that SALOME Object browser and Schema tree view are regrouped under tabs by default.
  36
  37 .. toctree::
  38    :maxdepth: 1
  39
  40    gui_components
  41    main_menu
  42    toolbars
  43
  44 .. raw:: LaTeX
  45
  46    \clearpage
  47
  48 Functionality list
  49 ==================
  50
  51 Let's describe the principal functionalities of objects creation, edition, visualization and execution of the YACS module.
  52
  53 .. toctree::
  54    :maxdepth: 2
  55
  56    operations
  57    modification
  58    representation
  59    execution
  60
  61 .. raw:: LaTeX
  62
  63    \clearpage
  64
  65 YACS schema examples
  66 ====================
  67
  68 In this section we consider several examples of YACS schemas.
  69
  70 .. toctree::
  71    :maxdepth: 2
  72
  73    scratch
  74    dataflow
  75