Salome HOME
mergefrom branch BR_V511_PR tag mergeto_trunk_03feb09
[modules/yacs.git] / doc / gui.rst
1 .. _gui:
2
3 *******************************************************
4 Utilisation de YACS avec l'interface graphique (GUI)
5 *******************************************************
6
7 YACS GUI description
8 ====================
9
10 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. The SALOME Object browser is only used to publish the run of the schema as a whole, and under the run, the outputs of the run that are published for the use of other SALOME modules. During the schema design (edition), a dedicated edition tree view of the YACS
11 data structure is used for schema building. Modifications are displayed on the 2D view.
12
13 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. The run tree view is used to control the execution (stop, breakpoints) and the 2D view reflects the detailed current state of execution.
14
15 The Python Console and Log Window in the low part of the desktop permits the user to invoke some YACS functionality from Python (for example, import XML graph from Python - not a normal use) and to display diagnostic messages correspondingly.
16
17 For the quick access to basic operations the system of context-dependent popup menu is supported. Popup menu is called by click of the right button of the mouse on the selected object.
18
19 The main window look & feel is presented schematically below.
20
21 .. _mainwindow:
22
23 .. figure:: images/yacs_gui_description_0.jpg
24   :align: center
25
26   Main Window
27
28 .. raw:: LaTeX
29
30    \clearpage
31
32 .. toctree::
33    :maxdepth: 1
34
35    gui_components
36    main_menu
37    toolbars
38
39 .. raw:: LaTeX
40
41    \clearpage
42
43 Functionality list
44 ==================
45
46 Let's describe the principal functionalities of objects creation, edition, visualization and execution of the YACS module.
47
48 .. toctree::
49    :maxdepth: 2
50
51    operations
52    modification
53    representation
54    execution
55
56 .. raw:: LaTeX
57
58    \clearpage
59
60 YACS schema examples
61 ====================
62
63 In this section we consider several examples of YACS schemas.
64
65 .. toctree::
66    :maxdepth: 2
67
68    scratch
69    dataflow
70