Widget Button
From eyeOS Wiki
Contents |
Introduction
Button is a widget designed to send signals: when the button is pressed, a signal is executed.
Keys
Available Generic Keys
- horiz: specifies whether its horizontal coordinate must be taken from the left (0) or the right (1) border of its container element. Default is 0 (left).
- vert: specifies whether its vertical coordinate must be taken from the top (0) or from the bottom (1) border of its container element. Default is 0 (top).
- x: specifies the horizontal displacement inside its "father" element, in pixels. Default is 10 pixels.
- y: specifies the vertical displacement inside its "father" element, in pixels. Default is 10 pixels.
- cent: specifies how the widget should be centered. Possible values are:
- 0: no centering. This is the default value.
- 1: center both horizontal and vertically.
- 2: center horizontally.
- 3: center vertically.
- 4: place the widget at the horizontal and vertical center of its container element.
- 5: place the widget at the horizontal center of its container element.
- 6: place the widget at the vertical center of its container element.
Please note the difference between options 1-3 and options 4-6. Options 1-3 calculate the size of the widget to ensure that the center of the widget is placed at the central point of its container, while options 4-6 set the central point coordinates as the widget's position.
- visible: toggles the widget visibility. Possible values are 0 (hidden) or 1 (visible). Default value is 1.
- enabled: specifies whether the widget is enabled (usable) or not. Default value is 1 (enabled), while disabled value is 0.
- signal: specifies which signal must be sent to the app when clicking the widget.
- disablemsg: enables or disables the widget's signal. A value of 1 disables the signal, while the default value of 0 enables it.
Specific Keys
- caption: the text content that the Button will display.
- img: convert the button in a image, but still send signals like a button
Methods
addEvent($eventName,$eventFunc,$args = )
- Description: makes the widget execute code every time certain event is triggered.
- Arguments:
- eventName: the name of the JS event. Example: onchange.
- eventFunc: the JS code to be executed.
- args: if any, the args passed to the system.
addFriend($friend)
- Description: defines a friend of the widget.
- Arguments:
- friend: the widget to be added as a friend.
disable()
- Description: makes the widget unusable.
- Arguments: none.
enable()
- Description: makes the widget usable.
- Arguments: none.
focus()
- Description: makes this widget as the selected one.
- Arguments: none.
hide()
- Description: makes the widget invisible.
- Arguments: none.
remove()
- Description: removes this widget, along with its child widgets.
- Arguments: none.
setCaption($newCaption)
- Description: sets the caption of (the text showed in) the button.
- Arguments:
- newCaption: text to be used as the Button's caption.
setCss($params)
- Description: sets CSS atributes to a widget.
- Arguments:
- params: specifies, in the form of an associative array, the CSS attributes to be applied. Remember that both the key and value of each element must be valid CSS properties and values respectively.
setHeight($height)
- Description: changes the height of the widget.
- Arguments:
- height: natural number specifying the new height.
setWidth($width)
- Description: changes the width of the widget.
- Arguments:
- width: natural number specifying the new width.
setX($x)
- Description: changes the horizontal position of the widget.
- Arguments:
- x: natural number specifying the new X coordinate.
setY($y)
- Description: changes the vertical position of the widget.
- Arguments:
- y: natural number specifying the new Y coordinate.
unfocus()
- Descripion: unselects this widget.
- Arguments: none.
unhide()
- Description: makes the widget visible.
- Arguments: none.
Can be serialized
Yes, passing a 0 as the argument of its show() method. If no argument is passed to show(), by default this widget won't be serialized.
