Difference between revisions of "Button"

From HSYCO
Jump to navigation Jump to search
 
(46 intermediate revisions by one other user not shown)
Line 1: Line 1:
[[Category:UI Objects]]
+
{{UI Object Header}}
 
Controls a light or automation device.
 
Controls a light or automation device.
  
When used to control a VSHUT or HSHUT automation interlocked device, pressing this button will cycle as follows:
+
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]].
UNKNOWN -> DOWN -> STOP -> UP -> STOP -> DOWN
+
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
*'''pos''': 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>; <pos>; <label>)
 
  
== UI Attributes ==
+
== Syntax ==
{| class="wikitable"
+
(button <address>; <position>; <label>)
!Name
+
E.g.
!Values
+
(button autom.1; x10y20; Front Door)
!Description
 
|-
 
|pos|x0y0|Position
 
|-
 
|visible|true, false|Is the object visible?
 
|-
 
|blink|true/slow, fast, false|Blinks the object. There are two possible speeds
 
|-
 
|opacity|0-1|Object opacity
 
|-
 
|focus|true|Focus field
 
|-
 
|img|full url (http://...), path relative to /img/|When it applies, changes the image source
 
draw|Draw instructions, ex: line(0,100,20,50,blue);line(50,50,70,70,'255,10,150');|When it applies, draws the image
 
|-
 
|text, label|string|When it applies, changes the label
 
|}
 

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)