CoreFlows/gui/doc/iramainwidget.rst

   1
   2 .. include:: ./rst_prolog.rst
   3
   4
   5 .. _iraMainWidget:
   6
   7 Solverlab GUI main widget
   8 ==========================
   9
  10 This is the main window of the Solverlab GUI. It's composed of three parts:
  11
  12 #. The **TOOLBAR** is at the top and is used to realise quick action
  13 #. The **TREE VIEW** is at the left and is used to import and modifie all data needed by Solverlab.
  14 #. The **CONTENT TAB** is at the center/right and has diverse utility
  15
  16
  17 .. image:: images/solverlabMainWidget1.png
  18    :scale: 75 %
  19    :align: center
  20
  21 Toolbar
  22 ------------
  23
  24 .. image:: images/solverlabMainWidgetToolbar1n.png
  25    :align: center
  26
  27 This toolbar contains icons related to actions, from left to right:
  28
  29 #. New Solverlab data. Create solverlab case from scratch
  30 #. Load Solverlab data. Load case from previously saved case in a file Xml.
  31 #. Save Solverlab data. Save current solverlab case in a file Xml.
  32 #. Launch Solverlab calculus. Launch Solverlab code on current solverlab case.
  33 #. Refresh SolverlabObjects tree view.
  34 #. Clear Solverlab data model, remove Solverlab data tree (in SolverlabObject widget).
  35 #. Solverlab GUI help. Display this current documentation in a browser (html mode).
  36 #. Solverlab code help. Display Solverlab code manual in a browser (pdf mode).
  37 #. Solverlab Example. Show directory with example of implemented model.
  38
  39 Solverlab tree view widget
  40 ----------------------------
  41
  42 From this tree view widget named *SolverlabObjects* users can prepare Solverlab code data.
  43
  44
  45 .. image:: images/solverlabTreeViewWidget1.png
  46    :scale: 70 %
  47    :align: center
  48
  49 Modify tree view widget items values
  50 ++++++++++++++++++++++++++++++++++++++
  51
  52 There are some values as leaves of tree. Names and tooltips are *almost* as Solverlab code naming usage.
  53
  54 #. **Simple scalar values**.
  55    User can modify value on *mouse-left-double-click*, selecting tree item nodes **hovering column value**.
  56 #. **Other specific values**.
  57    User can modify value on *mouse-right-click*, to get a contextual menu for modification,
  58    selecting tree item nodes **hovering columns name and value**.
  59
  60 .. note:: Some values are context specific and can be displayed only when they are needed.
  61
  62
  63 Tree view widget menus
  64 ++++++++++++++++++++++++
  65
  66 There are some menus, as *contextual menu* on *mouse-right-click* when selected tree item nodes.
  67 Some menu are generic, and other are specific to node, as contextual actions.
  68 This is a **NOT exhaustive** list of menus:
  69
  70 Expand/collapse menu
  71 ++++++++++++++++++++++
  72
  73 .. image:: images/solverlabExpandMenu1.png
  74    :scale: 80 %
  75    :align: center
  76
  77 This menu contains some actions to expand or collapse all or selected part of
  78 data tree.
  79 To activate this menu users have to *mouse-right-click* on **head of arrow**
  80 of tree item nodes (at **left** of item icon).
  81
  82 Delete/Insert menu
  83 ++++++++++++++++++++++
  84
  85 .. image:: images/solverlabDeleteMenu1.png
  86    :scale: 80 %
  87    :align: center
  88
  89 This menu contains some actions to insert, delete and reset all or selected part of
  90 data tree.
  91 To activate this menu users have to *mouse-right-click* on 'name' of tree item nodes
  92 (at right of item icon).
  93 The concerned items are usually not leaves (are items without a value).
  94
  95 Log Run Code widget
  96 --------------------
  97
  98 This widget displays log trace of Solverlab code execution.
  99
 100 Solverlab code is executed when users activate *Launch Solverlab calculus* button
 101 in the **TOOLBAR**.
 102
 103 .. image:: images/solverlabLogRunCodeWidget1.png
 104    :scale: 80 %
 105    :align: center
 106
 107 Log Run Code widget menu
 108 +++++++++++++++++++++++++
 109
 110 .. image:: images/solverlabLogWidgetMenu1.png
 111    :scale: 80 %
 112    :align: center
 113
 114 This menu contains some actions to display, but **also** edit all or selected part of
 115 current log trace, considering log trace as an ascii file.
 116 To activate this menu users have to *mouse-right-click* **somewhere in** Log Run Code widget.
 117
 118 .. note:: Using *Open* and *Save* actions in this menu, users can use this widget as
 119           an elementary text file viewer/editor.
 120
 121 Other File widget
 122 ------------------
 123
 124 This widget displays the content of the selected med file.
 125 It use the MEDCoupling API to do so.
 126
 127 .. image:: images/solverlabOtherTab.png
 128
 129 How to use
 130 +++++++++++
 131
 132 The user can *mouse-right-click* on the fileMed field in the **TREE VIEW** and select the "Dump ascii content" context menu.
 133