Widget Icon
From eyeOS Wiki
Contents |
Introduction
The Icon widget consists of an image normally used to determine the type of resource it refers to and a text label below showing its name. Every time an Icon is clicked or moved, the app can handle its signals to determine which actions to take when the user interacts with Icons.
Widget Use
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 (up).
- x: specifies the horizontal displacement inside its "father" element, in pixels. Default is 40 pixels.
- y: specifies the vertical displacement inside its "father" element, in pixels. Default is 40 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.
Specific Keys
- image: using the extern service, specifies the URL of the image used in the Icon.
- text: sets the text of the Icon that will be shown below of its image.
- draggable: specifies if the Icon is draggable (1) or not (0). Default value is 1.
- content: specifies, as an indexed array, the arguments of the message sent to the system every time an Icon is clicked or moved.
- myonload: if not empty, JS code executed when the Icon is loaded.
- overBorder: specifies if a border must be drawn when the cursor is over the icon (1) or not (0). Default value is 0.
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.
hide()
- Description: makes the widget invisible.
- Arguments: none.
remove()
- Description: removes this widget, along with its child widgets.
- Arguments: none.
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.
setCssText($params)
- Description: sets CSS atributes to the Icon text.
- 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.
unhide()
- Description: makes the widget visible.
- Arguments: none.
Can be serialized
No.
