doc/main_menu.rst

   1
   2 .. _main_menu:
   3
   4 Main Menu
   5 =========
   6
   7 The menu bar is located on the upper part of the desktop window. Available commands depends on the current selected schema and its mode (edition, run). The menus are specific for each mode and rebuilt as soon as the user changes the current mode. Relevant commands also depends on the item selected in the schema tree view.
   8
   9 Menu bar configurations in edition and run modes are given below.
  10
  11
  12
  13 .. image:: images/main_menu_0.jpg
  14   :align: center
  15   :width: 40ex
  16
  17
  18 .. centered::
  19   **Main Menu in edition mode**
  20
  21
  22
  23
  24 .. image:: images/main_menu_1.jpg
  25   :align: center
  26   :width: 35ex
  27
  28
  29 .. centered::
  30   **Main Menu in run mode**
  31
  32
  33 Let's consider the available menus in more detail.
  34
  35 .. _file:
  36
  37 File
  38 ----
  39 File menu contains standard operations for creating, opening and saving documents as well as import and export operations. The YACS GUI document is saved in a HDF file with default extension \*.hdf.
  40
  41 If YACS module has been loaded File menu contains the following items:
  42
  43
  44 .. image:: images/main_menu_2.jpg
  45   :align: center
  46   :width: 40ex
  47
  48
  49
  50
  51 + Import Schema:
  52
  53
  54
  55     + :ref:`import_yacs_schema`
  56
  57
  58     + :ref:`import_supervisor_graph`
  59
  60
  61
  62
  63
  64 + :ref:`export_schema`
  65
  66
  67 + :ref:`create_new_schema`
  68
  69
  70
  71
  72
  73 Edit
  74 ----
  75 Edit menu supports standard edition operations like copy/paste and undo/redo functionality. Cut, copy, paste, undo/redo should be available in edition mode only. ( **These items are not currently implemented, but will be available in the future version!** )
  76
  77
  78
  79 .. image:: images/main_menu_3.jpg
  80   :align: center
  81   :width: 20ex
  82
  83
  84
  85 Other edition operations on different types of objects are available with help of corresponding Input Panel property pages. For more information about this topic see :ref:`edit_object` section.
  86
  87 The user can :ref:`delete_object` with help of corresponding context popup menu item in the edition Tree View.
  88
  89
  90 View
  91 ----
  92 View menu allows maintaining visibility of the different parts of the desktop like toolbars, status bar, Object Browser, Python Console, Log Window.
  93
  94
  95
  96 .. image:: images/main_menu_4.jpg
  97   :align: center
  98   :width: 44ex
  99
 100
 101 .. centered::
 102    **Python Console**
 103
 104
 105 .. image:: images/main_menu_5.jpg
 106   :align: center
 107   :width: 41ex
 108
 109 .. centered::
 110   **Standard Toolbar**
 111
 112
 113 .. _create_menu:
 114
 115 Create
 116 ------
 117 Create menu contains a set of commands for creation of the YACS GUI objects. It is active only in the edition mode of a schema. Create menu contains the following items:
 118
 119
 120
 121
 122 + :ref:`create_container_definition`
 123
 124
 125 + :ref:`create_component_instance_definition`
 126
 127
 128
 129
 130
 131
 132
 133 .. image:: images/main_menu_6.jpg
 134   :align: center
 135   :width: 58ex
 136
 137
 138
 139
 140
 141
 142 + :ref:`create_node`
 143
 144
 145
 146
 147
 148 .. image:: images/main_menu_7.jpg
 149   :align: center
 150   :width: 48ex
 151
 152
 153 .. _execute:
 154
 155 Execute
 156 -------
 157 Execute menu contains a set of commands for execution of the YACS GUI schemas.
 158
 159 If the current mode is the edition mode of a schema, there is only possibility to create a schema run:
 160
 161
 162
 163 .. image:: images/main_menu_8.jpg
 164   :align: center
 165   :width: 38ex
 166
 167
 168
 169
 170
 171
 172 + :ref:`execute_schema`
 173
 174
 175 + :ref:`save_restore_execution_state` (from a state of execution saved previously)
 176
 177
 178 + New Batch Execution ( **Will be available in the future version!** )
 179
 180
 181
 182
 183
 184 Execute menu is active only if we are in the run mode of a schema. Execute menu contains the following items:
 185
 186
 187
 188 .. image:: images/main_menu_9.jpg
 189   :align: center
 190   :width: 44ex
 191
 192
 193
 194
 195
 196
 197 + Without stop Mode
 198
 199
 200 + Breakpoints Mode
 201
 202
 203 + Step by step Mode
 204
 205
 206 + Stop on error Option
 207
 208
 209 + Start/Resume
 210
 211
 212 + Pause
 213
 214
 215 + Abort
 216
 217
 218 + Reset
 219
 220
 221 + Execute in batch ( **Will be available in the future version!** )
 222
 223
 224 + Connect to a running batch session ... ( **Will be available in the future version!** )
 225
 226
 227 + Save execution state ...
 228
 229
 230 + New edition
 231
 232
 233
 234
 235
 236 Tools
 237 -----
 238 Tools menu provides two standard Salome useful tools such as XML catalog generator and registry display for supervision over component's processes.
 239
 240
 241
 242 .. image:: images/main_menu_10.jpg
 243   :align: center
 244   :width: 44ex
 245
 246
 247
 248
 249 Window
 250 ------
 251 Window menu contains commands to arrange already opened windows in a different ways (split horizontally or vertically) or to create a new window with predefined type.
 252
 253
 254
 255 .. image:: images/main_menu_11.jpg
 256   :align: center
 257   :width: 74ex
 258
 259
 260
 261
 262 Help
 263 ----
 264 Help menu allows reading some basic information about application with help of 'About' dialog box and provides help for YACS module as HTML documents.
 265
 266
 267
 268 .. image:: images/main_menu_12.jpg
 269   :align: center
 270   :width: 65ex
 271
 272