1

Pages, Jumps and HMI_NODE relativity

     2

====================================

     3

     4

Pages are full screen. Only one page is displayed at the same time.

     5

     6

Page change is triggered by ``HMI:Jump`` and ``HMI:Back``, or by changing ``/CURRENTPAGE_N``.

     7

     8

.. code-block:: text

     9

    10

    HMI:Page:PageName[@RootPath]

    11

    HMI:Jump:PageName[@RelativePath]

    12

    HMI:Back

    13

    14

Absolute and relative pages

    15

---------------------------

    16

    17

When ``[@RootPath]`` is given, page is relative.

    18

    19

When using ``HMI:Jump`` to reach a relative page, a compatible

    20

``[@RelativePath]`` may be provided.

    21

    22

To be compatible, ``RootPath`` and ``RelativePath`` must both point to

    23

HMI tree nodes of type ``HMI_NODE`` instanciated from same POU.

    24

    25

Every widget using a path descendant of ``RootPath`` in a relative

    26

page is relative. Relative widgets get the ``RootPath`` section of

    27

their path replaced by ``RelativePath``.

    28

    29

Relative page label::

    30

    31

    HMI:Page:PageName

    32

    33

Absolute page label::

    34

    35

    HMI:Page:PageName@RootPath

    36

    37

.. image:: svghmi_relative.svg

    38

    39

    40

Jump and Back

    41

-------------

    42

    43

    44

``HMI:Jump`` can have ``inactive``, ``active`` and ``disabled`` labeled children:

    45

    46

    * ``inactive`` is shown when target page is not currently displayed

    47

    * ``active`` is shown when target page is currently displayed

    48

    * ``disabled`` is shown when relative page's RootPath is set to 0, disabling jump.

    49

    50

Relative page label::

    51

    52

    HMI:Jump:PageName[@RelativePath]

    53

    54

Absolute page label::

    55

    56

    HMI:Jump:PageName

    57

    58

    59

``HMI:Back`` takes no parameter and just go back one step in page change history.

    60

    61

    62

Special ``/CURRENTPAGE_N`` variable

    63

-----------------------------------

    64

    65

..

    66

    TODO

    67

    68

    69

Overlapping geometry

    70

--------------------

    71

    72

If widget's bounding box is included in page bounding box, then widget is part of page.

    73

    74

..

    75

    TODO

    76

    77

    78

References frames

    79

-----------------

    80

    81

References frames help to unclutter page and widgets.

    82

    83

..

    84

    TODO

    85

    86

Screensaver

    87

-----------

    88

    89

..

    90

    TODO

    91

    92

Fading

    93

------

    94

    95

..

    96

    TODO