Difference between revisions of "Button"

From HSYCO
Jump to navigation Jump to search
 
(21 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[Category:UI Objects]]
+
{{UI Object Header}}
Controls a [[light]] or [[device|automation device]].
+
Controls a light or automation device.
  
If the button object is connected to a device or light that allows it, a long press on the button will open a [[popup]] with a [[slider]]. A second long press will close the [[popup]].
+
If the button object is connected to a light or automation device that allows it, a long press on the button will open a [[popup]] with a [[slider]]. A second long press will close the [[popup]].
If specified on [[SystemTopo]], it will show a thumbnail on mouse over or touch.
+
If specified on systemtopo.txt, it will show a thumbnail on mouse over or touch.
 +
 
 +
[[File:UI Object button.png]]
  
 
== Parameters ==
 
== Parameters ==
 
*'''address''': device data point name
 
*'''address''': device data point name
*'''position''': the position of the button. Use the pixels or rows and columns coordinates format
+
*'''position''': the object's position. Use the pixels or rows and columns coordinates format
*'''label''': the text label on the button. Can contain HTML tags.
+
*'''label''': the text label on the button. Can contain HTML tags
 
 
== index.hsc ==
 
(button <address>; <position>; <label>)
 
 
 
== UI Attributes ==
 
{{UI Object Attributes Common}}
 
{{UI Object Attributes Common Label}}
 
 
 
 
 
== Ooooor: ==
 
=== Common attributes ===
 
{| class="wikitable"
 
!Name
 
!Value
 
!Description
 
|-
 
|pos
 
|x[y]y[y] <nowiki>|</nowiki> r[r]c[c]
 
|Position specified as x/y coordinates or row/columns.
 
E.g. x-5y10 or r1c2
 
|-
 
 
 
|visible
 
|true
 
false
 
|Object visibility
 
|-
 
 
 
|rowspan="3"|blink
 
|true <nowiki>|</nowiki> slow
 
|rowspan="3"|Blinks the object.
 
There are two possible speeds: fast (same as true) or slow.
 
 
 
False stops the object's blinking.
 
|-
 
|fast
 
|-
 
|false
 
|-
 
 
 
|opacity
 
|0.0-1.0
 
|Object opacity. 0: not visible, 1: fully visible.
 
|-
 
 
 
|focus
 
|true
 
false
 
|Focus field
 
 
 
|}
 
 
 
=== OOOOrrr ===
 
 
 
=== Common attributes ===
 
{| class="wikitable"
 
!Name
 
!Value
 
!Description
 
|-
 
|pos
 
|
 
*x<y>y<y>
 
*r<r>c<c>
 
|Position specified as x/y coordinates or row/columns.
 
E.g. x-5y10 or r1c2
 
|-
 
 
 
|visible
 
|
 
*true
 
*false
 
|Object visibility
 
|-
 
 
 
|blink
 
|
 
*true <nowiki>|</nowiki> slow
 
*fast
 
*false
 
|Blinks the object.
 
There are two possible speeds: fast (same as true) or slow.
 
 
 
False stops the object's blinking.
 
|-
 
 
 
|opacity
 
|0.0-1.0
 
|Object opacity. 0: not visible, 1: fully visible.
 
|-
 
 
 
|focus
 
|
 
*true
 
*false
 
|Focus field
 
  
|}
+
== Syntax ==
 +
(button <address>; <position>; <label>)
 +
E.g.
 +
(button autom.1; x10y20; Front Door)

Latest revision as of 09:38, 28 April 2014

Note  For a description and a complete list of UI Objects, see UI Objects.

Controls a light or automation device.

If the button object is connected to a light or automation device that allows it, a long press on the button will open a popup with a slider. A second long press will close the popup. If specified on systemtopo.txt, it will show a thumbnail on mouse over or touch.

UI Object button.png

Parameters

  • address: device data point name
  • position: the object's position. Use the pixels or rows and columns coordinates format
  • label: the text label on the button. Can contain HTML tags

Syntax

(button <address>; <position>; <label>)

E.g.

(button autom.1; x10y20; Front Door)