7.6 Included Controls
7.6.1 Overview
gDesklets provides a basic set of Controls which can be used out-of-the-box. The following list shows all currently included Controls and their interface identifiers followed by more detailed information on each Control.
IArrayBuffer:10i2docuzddulm08s5h8qho3o-2 ICalendar:edslroj9o537asmjt8g2i7kse-2 IEventPipe:1v11pn3wj3jk1tmnnvl312sg3-2 IHDDTemp:6da6kg9xaciyyv0xvpexg8hyp-2 ISensor:blbed9sqifj2dnabrwpbd7guz-2 ISystem:4zcicmk4botcub7iypo46t2l7-2 ITime:7qktelp6tw29ve5p8q3lxn6bs-2 IURI:3mufry4gxx4vihs2dufszo21p-2
7.6.2 ArrayBuffer
An object buffer that makes it easier to scroll and update arrays of objects.
IArrayBuffer:10i2docuzddulm08s5h8qho3o-2 cursor rw Get/Set cursor position delete w Delete line from buffer fill w Fill the buffer with an object filltype rw Get/Set the empty space fill type read r Return the viewable window array read_all r Return the entire buffer array size rw Get/Set buffer size window_pos rw Get/Set viewable window position window_size rw Get/Set viewable window size write w Write line at position cursor
7.6.3 Calendar
no description
ICalendar:edslroj9o537asmjt8g2i7kse-2 day r no description days r no description month r no description months r no description time w no description
7.6.4 EventPipe
Control for piping events to other desklets.
This control acts as a hub providing a push based notification system with different channels of interests.
You can use this control to subscribe to channels in order to automatically receive messages:
epipe.subscriptions = ["SideCandy", "System"]
By binding a handler to the "event" property, you can receive broadcasted messages:
epipe.bind("event", on_epipe_message)In order to broadcast a message to other desklets, you put the message into the "event" property:
epipe.event = ("SideCandy", "my message")A message is a list of elements, where the first element is the name of the channel, and the second is the name of the message. The list may also contain further, arbitrary elements, but the channel and the message name must be strings.
IEventPipe:1v11pn3wj3jk1tmnnvl312sg3-2 event rw no description subscriptions rw The subscribed channels
The “event” property is bindable.
7.6.5 HDDTemp
Control for retrieving HDD temperature from a local hddtemp daemon.
IHDDTemp:6da6kg9xaciyyv0xvpexg8hyp-2 available_devices r no description device rw no description poll r no description poll_all r no description
7.6.6 Sensor
 |
|
This control wraps legacy sensors to make them still usable. Sensors are deprecated and shouldn't be used in new stuff. This control is solely meant for retaining backwards compatibility. |
ISensor:blbed9sqifj2dnabrwpbd7guz-2 action w the action to perform config_id w the config ID configurator r the configurator of the sensor menu r the menu data of the sensor output r the output data of the sensor sensor w the sensor stop w stops the sensor
The “output” and “menu” properties are bindable.
7.6.7 System
This Control offers access to a lot of information about the System and its current state.
ISystem:4zcicmk4botcub7iypo46t2l7-2 allfs rw Getter/Setter for boolean allfs cpu r General CPU info cpu_bogomips r CPU bogomips cpu_cache r CPU 2nd level cache cpu_clock r CPU clock cpu_load r CPU load cpu_model r CPU model fsusage r Information of given mounted filesystem hostname r The machine's hostname iface rw Getter/Setter for network interface kernel_version r Kernel version loadavg r Average load info memory r Memory information mountdir rw Getter/Setter for mountdir mountlist r (All) mountpoints net_devices r Available network devs net_load r Netload of given device net_speed r Incoming / Outgoing traffic speed of given device net_state r Device up or down operating_system r Type of operating system pid rw Getter/Setter for pid ppp r Point-to-Point information proc_args r Command line args of process ID proc_kernel r no description proc_list r no description proc_map r no description proc_mem r no description proc_segment r no description proc_signal r no description proc_state r no description proc_time r no description proc_uid r no description swap r Swap space information uptime r Uptime information users r Number of users which rw Getter/Setter for which
The “allfs”, “device”, “mountdir”, “pid” and “which” properties are bindable.
7.6.8 Time
Control for current time and date information.
ITime:5oak91gpdt1dyiepbqmn48plp-2 date r the current date (y, m, d) ticks r the current ticks in floating point numbers time r the current time (h, m, s) timezone rw the timezone
The “date”, “time” and “timezone” properties are bindable.
7.6.9 URI
A Control to read out data from a file.
IURI:3mufry4gxx4vihs2dufszo21p-2 file rw raw file content raw r raw file content splitted r splitted file content stripped r stripped file content