doc/svghmi/pages.rst
changeset 3936 129202e555e0
parent 3929 1a0bed0b4f1c
equal deleted inserted replaced
3932:62d04933d569 3936:129202e555e0
    32 
    32 
    33 Absolute page label::
    33 Absolute page label::
    34 
    34 
    35     HMI:Page:PageName@RootPath
    35     HMI:Page:PageName@RootPath
    36 
    36 
       
    37 Example::
       
    38 
       
    39     HMI:Page:PumpControl@/PUMP0
       
    40 
    37 .. image:: svghmi_relative.svg
    41 .. image:: svghmi_relative.svg
    38 
    42 
    39 
    43 
    40 Jump and Back
    44 Jumps
    41 -------------
    45 -----
    42 
    46 
    43 
    47 
    44 ``HMI:Jump`` can have ``inactive``, ``active`` and ``disabled`` labeled children:
    48 ``HMI:Jump`` can have ``inactive``, ``active`` and ``disabled`` labeled children:
    45 
    49 
    46     * ``inactive`` is shown when target page is not currently displayed
    50     * ``inactive`` is shown when target page is not currently displayed
    47     * ``active`` is shown when target page is currently displayed
    51     * ``active`` is shown when target page is currently displayed
    48     * ``disabled`` is shown when relative page's RootPath is set to 0, disabling jump.
    52     * ``disabled`` is shown when relative page's RootPath is set to 0, disabling jump.
    49 
    53 
    50 Relative page label::
    54 Relative page label::
    51 
    55 
    52     HMI:Jump:PageName[@RelativePath]
    56     HMI:Jump:PageName@RelativePath
    53 
    57 
    54 Absolute page label::
    58 Absolute page label::
    55 
    59 
    56     HMI:Jump:PageName
    60     HMI:Jump:PageName
    57 
    61 
       
    62 Example::
    58 
    63 
    59 ``HMI:Back`` takes no parameter and just go back one step in page change history.
    64     HMI:Jump:PumpControl@/PUMP7
    60 
    65 
    61 
    66 
    62 Special ``/CURRENTPAGE_N`` variable
    67 Back: Jump to previous page
       
    68 ----------------------------
       
    69 
       
    70 ``HMI:Back`` takes no parameter and goes back one step in page change history when clicked.
       
    71 
       
    72 
       
    73 Special ``/CURRENT_PAGE_n`` variable
    63 -----------------------------------
    74 -----------------------------------
       
    75 
       
    76 Each SVGHMI instance have its own ``/CURRENT_PAGE_n``, with ``n`` being the position of SVGHMI instance in Configuration Tree.
       
    77 
       
    78 By reading ``/CURRENT_PAGE_n`` value, PLC knows last page being displayed in HMI. Variable is of type STRING, and formatted as follows::
       
    79 
       
    80     PageName
       
    81 
       
    82 
    64 
    83 
    65 ..
    84 ..
    66     TODO
    85     TODO
    67 
    86 
    68 
    87 
    71 
    90 
    72 If widget's bounding box is included in page bounding box, then widget is part of page.
    91 If widget's bounding box is included in page bounding box, then widget is part of page.
    73 
    92 
    74 ..
    93 ..
    75     TODO
    94     TODO
       
    95 
       
    96 Discarded element
       
    97 -----------------
    76 
    98 
    77 
    99 
    78 References frames
   100 References frames
    79 -----------------
   101 -----------------
    80 
   102