Module: lib-tde.signals

Internal signal delegator, this module manages signals from and to different components of TDE

This package contains a lot of signals.

most are in the form:

emit_property_ram("123450")
connect_property_ram(
 function(value)
   print("Received: " .. value)
 end)

This module tries to improve re-usage of know variables throughout the tde infrastructure.

Class Hierarchy

Info:

  • Copyright: 2020 Tom Meyers
  • Author: Tom Meyers

Static module functions

lib-tde.signals.emit_module_exit_screen_hide (func) Notify other TDE components that the exit_screen should be hidden
lib-tde.signals.connect_module_exit_screen_hide (func) Trigger a callback function when the exit screen goes hidden
lib-tde.signals.emit_module_exit_screen_show () Notify other TDE components that the battery has updated its value
lib-tde.signals.connect_module_exit_screen_show (func) Trigger a callback function when the exit screen is being show
lib-tde.signals.emit_module_battery (value) Notify other TDE components that the battery has updated its value
lib-tde.signals.connect_battery (func) Trigger a callback function when the battery is updated
lib-tde.signals.emit_module_battery_charging (value) Notify other TDE components that the battery charging has changed
lib-tde.signals.connect_battery_charging (func) Trigger a callback function when the battery charging changed
lib-tde.signals.emit_brightness (value) Notify other TDE components that the screen brightness has changed
lib-tde.signals.connect_brightness (func) Trigger a callback function when the brightness changed
lib-tde.signals.emit_volume (value) Notify other TDE components that the screen volume has changed
lib-tde.signals.connect_volume (func) Trigger a callback function when the volume changed
lib-tde.signals.emit_volume_update () Request an update to check to volume value
lib-tde.signals.connect_volume_update (func) Trigger a callback function when a client requests a volume update
lib-tde.signals.emit_volume_is_muted (value) Notify other TDE components that the volume mute state changed
lib-tde.signals.connect_volume_is_muted (func) Trigger a callback function when the volume mute state changed
lib-tde.signals.emit_weather (string, string, string) Notify other TDE components that the weather updated
lib-tde.signals.connect_weather (func) Trigger a callback function when the weather info changed
lib-tde.signals.emit_username (value) Notify other TDE components that the username changed
lib-tde.signals.connect_username (func) Trigger a callback function when the user changed
lib-tde.signals.emit_distro (value) Notify other TDE components that the distro name changed
lib-tde.signals.connect_distro (func) Trigger a callback function when the distro changed
lib-tde.signals.emit_uptime (value) Notify other TDE components that the uptime changed
lib-tde.signals.connect_uptime (func) Trigger a callback function when the uptime changed
lib-tde.signals.emit_kernel (value) Notify other TDE components what the current kernel version is
lib-tde.signals.connect_kernel (func) Trigger a callback function when the kernel changed
lib-tde.signals.emit_packages_to_update (value) Notify other TDE components how many packages should be updated
lib-tde.signals.connect_packages_to_update (func) Trigger a callback function when packages to update changed
lib-tde.signals.emit_cpu_usage (value) Notify other TDE components about the current cpu usage
lib-tde.signals.connect_cpu_usage (func) Trigger a callback function when the cpu usage has been updated
lib-tde.signals.emit_disk_usage (value) Notify other TDE components about the current disk usage
lib-tde.signals.connect_disk_usage (func) Trigger a callback function when the disk usage has been updated
lib-tde.signals.emit_disk_space (value) Notify other TDE components about the total disk space
lib-tde.signals.connect_disk_space (func) Trigger a callback function when the disk space has been updated
lib-tde.signals.emit_ram_usage (value) Notify other TDE components about the current ram usage
lib-tde.signals.connect_ram_usage (func) Trigger a callback function when the ram usage has been updated
lib-tde.signals.emit_ram_total (value) Notify other TDE components about the total ram
lib-tde.signals.connect_ram_total (func) Trigger a callback function for the total ram amount
lib-tde.signals.emit_bluetooth_status (value) Notify other TDE components about the current bluetooth status
lib-tde.signals.connect_bluetooth_status (func) Trigger a callback function for the current bluetooth status
lib-tde.signals.emit_wifi_status (value) Notify other TDE components about the current wifi status
lib-tde.signals.connect_wifi_status (func) Trigger a callback function for the current wifi status
lib-tde.signals.connect_exit (func) Trigger a callback function when we are about to shut down
lib-tde.signals.emit_mouse_acceleration (the) Notify other TDE components about the change in mouse acceleration
lib-tde.signals.connect_mouse_acceleration (func) Trigger a callback function when the mouse acceleration changed
lib-tde.signals.emit_mouse_speed (the) Notify other TDE components about the change in mouse speed
lib-tde.signals.connect_mouse_speed (func) Trigger a callback function when the mouse speed changed
lib-tde.signals.emit_mouse_natural_scrolling (the) Notify other TDE components about the change in mouse natural scrolling
lib-tde.signals.connect_mouse_natural_scrolling (func) Trigger a callback function when the mouse natural scrolling state changed
lib-tde.signals.emit_refresh_screen () Notify wiboxes when the screen layout is updated (so they can update their position)
lib-tde.signals.connect_refresh_screen (func) Trigger a callback function when a wibox should update their position on the screen
lib-tde.signals.emit_profile_picture_changed (picture) Notify when the user profile picture changed
lib-tde.signals.profile_picture_changed (func) Trigger a callback function when the user profile picture changed
lib-tde.signals.emit_do_not_disturb (bDoNotDisturb) Notify when the notification disturb state changes
lib-tde.signals.connect_do_not_disturb (func) Trigger a callback function when the do not disturb mode changed
lib-tde.signals.emit_primary_theme_changed (theme) Notify when the primary theme changed
lib-tde.signals.connect_primary_theme_changed (func) Trigger a callback function when the primary theme changed
lib-tde.signals.emit_background_theme_changed (theme) Notify when the background theme changed
lib-tde.signals.connect_background_theme_changed (func) Trigger a callback function when the background theme changed
lib-tde.signals.emit_oled_mode (theme) Notify when the oled brightness mode changed
lib-tde.signals.connect_oled_mode (func) Trigger a callback function when the oled brightness mode changed

Signals

debug::error A call into the Lua code aborted with an error. Inherited from awesome
debug::deprecation A deprecated Lua function was called. Inherited from awesome
debug::index::miss An invalid key was read from an object. Inherited from awesome
debug::newindex::miss An invalid key was written to an object. Inherited from awesome
systray::update The systray should be updated. Inherited from awesome
wallpaper_changed The wallpaper has changed. Inherited from awesome
xkb::map_changed Keyboard map has changed. Inherited from awesome
xkb::group_changed. Keyboard group has changed. Inherited from awesome
refresh Refresh. Inherited from awesome
startup AwesomeWM is about to enter the event loop. Inherited from awesome
exit AwesomeWM is exiting / about to restart. Inherited from awesome
screen::change The output status of a screen has changed. Inherited from awesome
spawn::canceled For some reason the application aborted startup Inherited from awesome
spawn::change When one of the fields from the ??? table changes Inherited from awesome
spawn::completed An application finished starting Inherited from awesome
spawn::initiated When a new client is beginning to start Inherited from awesome
spawn::timeout An application started a spawn event but didn't start in time. Inherited from awesome

Fields

awesome.version string The AwesomeWM version. Inherited from awesome
awesome.release string The AwesomeWM release name. Inherited from awesome
awesome.api_level string The AwesomeWM API level. Inherited from awesome
awesome.conffile string The configuration file which has been loaded. Inherited from awesome
awesome.startup boolean True if we are still in startup, false otherwise. Inherited from awesome
awesome.startup_errors string Error message for errors that occured during startup. Inherited from awesome
awesome.composite_manager_running boolean True if a composite manager is running. Inherited from awesome
awesome.unix_signal table Table mapping between signal numbers and signal identifiers. Inherited from awesome
awesome.hostname string The hostname of the computer on which we are running. Inherited from awesome
awesome.themes_path string The path where themes were installed to. Inherited from awesome
awesome.icon_path string The path where icons were installed to. Inherited from awesome


Static module functions

lib-tde.signals.emit_module_exit_screen_hide (func)
Notify other TDE components that the exit_screen should be hidden

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components
     lib-tde.signals.emit_module_exit_screen_hide()
lib-tde.signals.connect_module_exit_screen_hide (func)
Trigger a callback function when the exit screen goes hidden

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components
    lib-tde.signals.connect_module_exit_screen_hide(
       function ()
         print("exit screen hidden")
       end)
lib-tde.signals.emit_module_exit_screen_show ()
Notify other TDE components that the battery has updated its value

Usage:

    -- notify other components
     lib-tde.signals.emit_module_exit_screen_show()
lib-tde.signals.connect_module_exit_screen_show (func)
Trigger a callback function when the exit screen is being show

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components
    lib-tde.signals.connect_module_exit_screen_show(
       function ()
         print("exit screen shown")
       end)
lib-tde.signals.emit_module_battery (value)
Notify other TDE components that the battery has updated its value

Parameters:

  • value number The current percentage of the battery

Usage:

    -- notify other components when the battery is updated
     lib-tde.signals.emit_battery()
lib-tde.signals.connect_battery (func)
Trigger a callback function when the battery is updated

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when the battery updates
    lib-tde.signals.connect_battery(
       function (value)
         print("Battery is: " .. tostring(value))
       end)
lib-tde.signals.emit_module_battery_charging (value)
Notify other TDE components that the battery charging has changed

Parameters:

  • value bool if it is charging

Usage:

    -- notify other components when the battery charging changed
     lib-tde.signals.emit_battery_charging()
lib-tde.signals.connect_battery_charging (func)
Trigger a callback function when the battery charging changed

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when the battery charging updates
    lib-tde.signals.connect_battery(
       function (value)
         print("Battery charging state: " .. tostring(value))
       end)
lib-tde.signals.emit_brightness (value)
Notify other TDE components that the screen brightness has changed

Parameters:

  • value number The brightness between 0 and 100

Usage:

    -- notify other components when the brightness changed
     lib-tde.signals.emit_brightness(100)
lib-tde.signals.connect_brightness (func)
Trigger a callback function when the brightness changed

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when the brightness changed
    lib-tde.signals.connect_brightness(
       function (value)
         print("Current brightness: " .. tostring(value))
       end)
lib-tde.signals.emit_volume (value)
Notify other TDE components that the screen volume has changed

Parameters:

  • value number The volume between 0 and 100

Usage:

    -- notify other components when the volume changed
     lib-tde.signals.emit_volume(100)
lib-tde.signals.connect_volume (func)
Trigger a callback function when the volume changed

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when the volume changed
    lib-tde.signals.connect_volume(
       function (value)
         print("Current volume: " .. tostring(value))
       end)
lib-tde.signals.emit_volume_update ()
Request an update to check to volume value

Usage:

    -- Notify that you changed the state of volume
     lib-tde.signals.emit_volume_update()
lib-tde.signals.connect_volume_update (func)
Trigger a callback function when a client requests a volume update

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- listen for clients that need the latest volume state
    lib-tde.signals.connect_volume_update(
       function ()
         print("Request to search for latest volume state")
       end)
lib-tde.signals.emit_volume_is_muted (value)
Notify other TDE components that the volume mute state changed

Parameters:

  • value bool True if the volume is muted

Usage:

    -- notify other components when the volume mute state changed
     lib-tde.signals.emit_volume_is_muted(true)
lib-tde.signals.connect_volume_is_muted (func)
Trigger a callback function when the volume mute state changed

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when the volume mute state changed
    lib-tde.signals.connect_volume_is_muted(
       function (isMuted)
         print("Is volume enabled? " .. tostring(isMuted))
       end)
lib-tde.signals.emit_weather (string, string, string)
Notify other TDE components that the weather updated

Parameters:

  • string icon An icon code use to differentiate the weather
  • string icon An icon code use to differentiate the weather
  • string icon An icon code use to differentiate the weather

Usage:

    -- notify other components when the weather is updated
     lib-tde.signals.emit_weather("14°C", "Cloudy with a change of meatballs", "99")
lib-tde.signals.connect_weather (func)
Trigger a callback function when the weather info changed

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when the weather is updated
    lib-tde.signals.connect_weather(
       function (temp, desc, icon)
         print("Current temperature: " .. tostring(temp))
         print("Current description: " .. tostring(desc))
       end)
lib-tde.signals.emit_username (value)
Notify other TDE components that the username changed

Parameters:

Usage:

    -- notify other components when the user changed
     lib-tde.signals.emit_user("user_1")
lib-tde.signals.connect_username (func)
Trigger a callback function when the user changed

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when the user changed
    lib-tde.signals.connect_username(
       function (value)
         print("Current user: " .. value)
       end)
lib-tde.signals.emit_distro (value)
Notify other TDE components that the distro name changed

Parameters:

  • value string The distribution name

Usage:

    -- notify other components when the distro changed
     lib-tde.signals.emit_distro("TOS Linux")
lib-tde.signals.connect_distro (func)
Trigger a callback function when the distro changed

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when the distro changed
    lib-tde.signals.connect_distro(
       function (value)
         print("Current distro: " .. value)
       end)
lib-tde.signals.emit_uptime (value)
Notify other TDE components that the uptime changed

Parameters:

Usage:

    -- notify other components when the uptime changed
     lib-tde.signals.emit_uptime("10 seconds")
lib-tde.signals.connect_uptime (func)
Trigger a callback function when the uptime changed

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when the uptime changed
    lib-tde.signals.connect_uptime(
       function (value)
         print("Current uptime: " .. value)
       end)
lib-tde.signals.emit_kernel (value)
Notify other TDE components what the current kernel version is

Parameters:

  • value string The kernel version

Usage:

    -- notify other components what the current kernel is
     lib-tde.signals.emit_kernel("v5.0.0-tos1")
lib-tde.signals.connect_kernel (func)
Trigger a callback function when the kernel changed

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when the kernel changed
    lib-tde.signals.connect_kernel(
       function (value)
         print("Current kernel: " .. value)
       end)
lib-tde.signals.emit_packages_to_update (value)
Notify other TDE components how many packages should be updated

Parameters:

  • value string The amount of updates

Usage:

    -- notify other components how much packages need to be updated
     lib-tde.signals.emit_kernel("7")
lib-tde.signals.connect_packages_to_update (func)
Trigger a callback function when packages to update changed

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when system packages need updates
    lib-tde.signals.connect_packages_to_update(
       function (value)
         print("Packages to update: " .. value)
       end)
lib-tde.signals.emit_cpu_usage (value)
Notify other TDE components about the current cpu usage

Parameters:

  • value number The current cpu usage in percentage

Usage:

    -- notify other components of the current cpu usage
     lib-tde.signals.emit_cpu_usage("32")
lib-tde.signals.connect_cpu_usage (func)
Trigger a callback function when the cpu usage has been updated

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when cpu usage changed
    lib-tde.signals.connect_cpu_usage(
       function (value)
         print("CPU usage: " .. tostring(value) .. "%")
       end)
lib-tde.signals.emit_disk_usage (value)
Notify other TDE components about the current disk usage

Parameters:

  • value number The current disk usage in percentage

Usage:

    -- notify other components of the current disk usage
     lib-tde.signals.emit_disk_usage("32")
lib-tde.signals.connect_disk_usage (func)
Trigger a callback function when the disk usage has been updated

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when disk usage changed
    lib-tde.signals.connect_disk_usage(
       function (value)
         print("DISK usage: " .. tostring(value) .. "%")
       end)
lib-tde.signals.emit_disk_space (value)
Notify other TDE components about the total disk space

Parameters:

  • value string The current total disk space in percentage

Usage:

    -- notify other components of the total disk space
     lib-tde.signals.emit_disk_space("467G")
lib-tde.signals.connect_disk_space (func)
Trigger a callback function when the disk space has been updated

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when disk space changed
    lib-tde.signals.connect_disk_space(
       function (value)
         print("DISK space: " .. tostring(value) .. "%")
       end)
lib-tde.signals.emit_ram_usage (value)
Notify other TDE components about the current ram usage

Parameters:

  • value number The current ram usage in percentage

Usage:

    -- notify other components of the current ram usage
     lib-tde.signals.emit_ram_usage("32")
lib-tde.signals.connect_ram_usage (func)
Trigger a callback function when the ram usage has been updated

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when ram usage changed
    lib-tde.signals.connect_ram_usage(
       function (value)
         print("RAM usage: " .. tostring(value) .. "%")
       end)
lib-tde.signals.emit_ram_total (value)
Notify other TDE components about the total ram

Parameters:

  • value string The total ram available on the system in kilobytes

Usage:

    -- notify other components of the total ram in kilobytes
     lib-tde.signals.emit_ram_total("14000000")
lib-tde.signals.connect_ram_total (func)
Trigger a callback function for the total ram amount

Parameters:

  • func function The callback function that will be called when the event happens

Usage:

    -- notify other components when total ram changed
    lib-tde.signals.connect_ram_total(
       function (value)
         print("RAM total: " .. tostring(value) .. "%")
       end)
lib-tde.signals.emit_bluetooth_status (value)
Notify other TDE components about the current bluetooth status

Parameters:

  • value boolean If bluetooth is on or off

Usage:

    -- Notify other TDE components about the current bluetooth status
     lib-tde.signals.emit_bluetooth_status(true)
lib-tde.signals.connect_bluetooth_status (func)
Trigger a callback function for the current bluetooth status

Parameters:

  • func function The callback function that will be called when the bluetooth status changes

Usage:

    -- notify other components when bluetooth status changes
    lib-tde.signals.connect_bluetooth_status(
       function (value)
         print("Bluetooth active?: " .. tostring(value))
       end)
lib-tde.signals.emit_wifi_status (value)
Notify other TDE components about the current wifi status

Parameters:

  • value boolean If wifi is on or off

Usage:

    -- Notify other TDE components about the current wifi status
     lib-tde.signals.emit_wifi_status(true)
lib-tde.signals.connect_wifi_status (func)
Trigger a callback function for the current wifi status

Parameters:

  • func function The callback function that will be called when the bluetooth status changes

Usage:

    -- notify other components when wifi status changes
    lib-tde.signals.connect_wifi_status(
       function (value)
         print("Wifi active?: " .. tostring(value))
       end)
lib-tde.signals.connect_exit (func)
Trigger a callback function when we are about to shut down

Parameters:

  • func function The callback function that will be called when we are shutting down

Usage:

    -- this function will be called when shutting down
    lib-tde.signals.connect_exit(
       function ()
         print("Goodbye")
       end)
lib-tde.signals.emit_mouse_acceleration (the)
Notify other TDE components about the change in mouse acceleration

Parameters:

  • the table mouse id and speed value

Usage:

    -- Notify other TDE components about the change in mouse acceleration
     lib-tde.signals.emit_mouse_acceleration({id: 11, speed: 1.5})
lib-tde.signals.connect_mouse_acceleration (func)
Trigger a callback function when the mouse acceleration changed

Parameters:

  • func function The callback function that will be called when the mouse acceleration changed

Usage:

    -- notify other components when the mouse acceleration changed
    lib-tde.signals.connect_mouse_acceleration(
       function (value)
         print("Mouse acceleration settings: " .. value.id .. " with speed:" .. value.speed)
       end)
lib-tde.signals.emit_mouse_speed (the)
Notify other TDE components about the change in mouse speed

Parameters:

  • the table mouse id and speed value

Usage:

    -- Notify other TDE components about the change in mouse speed
     lib-tde.signals.emit_mouse_speed({id: 11, speed: 1.5})
lib-tde.signals.connect_mouse_speed (func)
Trigger a callback function when the mouse speed changed

Parameters:

  • func function The callback function that will be called when the mouse speed changed

Usage:

    -- notify other components when the mouse speed changed
    lib-tde.signals.connect_mouse_speed(
       function (value)
         print("Mouse speed settings: " .. value.id .. " with speed:" .. value.speed)
       end)
lib-tde.signals.emit_mouse_natural_scrolling (the)
Notify other TDE components about the change in mouse natural scrolling

Parameters:

  • the table mouse id and natural scrolling state

Usage:

    -- Notify other TDE components about the change in mouse natural scrolling state
     lib-tde.signals.emit_mouse_speed({id: 11, state: true})
lib-tde.signals.connect_mouse_natural_scrolling (func)
Trigger a callback function when the mouse natural scrolling state changed

Parameters:

  • func function The callback function that will be called when the mouse natural scrolling state changed

Usage:

    -- notify other components when the mouse natural scrolling state changed
    lib-tde.signals.connect_mouse_natural_scrolling(
       function (value)
         print("Mouse natural scrolling state settings: " .. value.id .. " with state:" .. value.state)
       end)
lib-tde.signals.emit_refresh_screen ()
Notify wiboxes when the screen layout is updated (so they can update their position)

Usage:

    -- Notify other TDE components about the screen update
     lib-tde.signals.emit_refresh_screen()
lib-tde.signals.connect_refresh_screen (func)
Trigger a callback function when a wibox should update their position on the screen

Parameters:

  • func function The callback function that will be called when the screen geometry changed

Usage:

    --
    lib-tde.signals.connect_refresh_screen(
       function ()
         print("Some screen updated")
       end)
lib-tde.signals.emit_profile_picture_changed (picture)
Notify when the user profile picture changed

Parameters:

  • picture string The profile picture file path

Usage:

    -- Notify other TDE components when the user profile picture changed
     lib-tde.signals.emit_profile_picture_changed()
lib-tde.signals.profile_picture_changed (func)
Trigger a callback function when the user profile picture changed

Parameters:

  • func function The callback function that will be called when the user profile picture changed

Usage:

    --
    lib-tde.signals.profile_picture_changed(
       function (picture)
         print("Changed profile picture to: " .. picture)
       end)
lib-tde.signals.emit_do_not_disturb (bDoNotDisturb)
Notify when the notification disturb state changes

Parameters:

  • bDoNotDisturb bool If Do Not Disturb mode is turned on

Usage:

    -- Notify other TDE components what the current do not disturb mode is
     lib-tde.signals.emit_do_not_disturb()
lib-tde.signals.connect_do_not_disturb (func)
Trigger a callback function when the do not disturb mode changed

Parameters:

  • func function The callback function that will be called when the do not disturb mode changed

Usage:

    --
    lib-tde.signals.connect_do_not_disturb(
       function (bDoNotDisturb)
         print("Do not disturb mode: " .. tostring(bDoNotDisturb))
       end)
lib-tde.signals.emit_primary_theme_changed (theme)
Notify when the primary theme changed

Parameters:

  • theme table The new theme pallet

Usage:

    -- Notify other TDE components that the primary theme changed
     lib-tde.signals.emit_primary_theme_changed()
lib-tde.signals.connect_primary_theme_changed (func)
Trigger a callback function when the primary theme changed

Parameters:

  • func function The callback function that will be called when the primary theme changed

Usage:

    --
    lib-tde.signals.connect_primary_theme_changed(
       function (theme)
         print("The hue_600 color of this theme: " .. theme.hue_600)
       end)
lib-tde.signals.emit_background_theme_changed (theme)
Notify when the background theme changed

Parameters:

  • theme table The new theme pallet

Usage:

    -- Notify other TDE components that the background theme changed
     lib-tde.signals.emit_background_theme_changed()
lib-tde.signals.connect_background_theme_changed (func)
Trigger a callback function when the background theme changed

Parameters:

  • func function The callback function that will be called when the background theme changed

Usage:

    --
    lib-tde.signals.connect_background_theme_changed(
       function (theme)
         print("The hue_600 color of this theme: " .. theme.hue_600)
       end)
lib-tde.signals.emit_oled_mode (theme)
Notify when the oled brightness mode changed

Parameters:

  • theme table The new theme pallet

Usage:

    -- Notify other TDE components that the oled brightness mode changed
     lib-tde.signals.emit_oled_mode(true)
lib-tde.signals.connect_oled_mode (func)
Trigger a callback function when the oled brightness mode changed

Parameters:

  • func function The callback function that will be called when the oled brightness mode changed

Usage:

    --
    lib-tde.signals.connect_oled_mode(
       function (bIsOledMode)
         print("Is oled mode enabled?: " .. tostring(bIsOledMode))
       end)

Signals

debug::error · Inherited from awesome
A call into the Lua code aborted with an error.

This signal is used in the example configuration, ???, to let a notification box pop up.

Arguments:

  • err Table with the error object, can be converted to a string with tostring(err).
debug::deprecation · Inherited from awesome
A deprecated Lua function was called.

Arguments:

  • hint string String with a hint on what to use instead of the deprecated functionality.
  • see string or nil The name of the newer API (default nil)
  • args table or nil The name of the newer API (default nil)
debug::index::miss · Inherited from awesome
An invalid key was read from an object.

This can happen if foo in an c.foo access does not exist.

Arguments:

  • unknown1 Class?
  • unknown2 Key?
debug::newindex::miss · Inherited from awesome
An invalid key was written to an object.

This can happen if foo in an c.foo = "bar" assignment doesn't exist.

Arguments:

  • unknown1 Class?
  • unknown2 Key?
  • unknown3 Value?
systray::update · Inherited from awesome
The systray should be updated.

This signal is used in wibox.widget.systray.

wallpaper_changed · Inherited from awesome
The wallpaper has changed.

This signal is used for pseudo-transparency in wibox.drawable if no composite manager is running.

xkb::map_changed · Inherited from awesome
Keyboard map has changed.

This signal is sent after the new keymap has been loaded. It is used in awful.widget.keyboardlayout to redraw the layout.

xkb::group_changed. · Inherited from awesome
Keyboard group has changed.

It's used in awful.widget.keyboardlayout to redraw the layout.

Arguments:

  • group Integer containing the changed group
refresh · Inherited from awesome
Refresh.

This signal is emitted as a kind of idle signal in the event loop. One example usage is in gears.timer to executed delayed calls.

startup · Inherited from awesome
AwesomeWM is about to enter the event loop.

This means all initialization has been done.

exit · Inherited from awesome
AwesomeWM is exiting / about to restart.

This signal is emitted in the atexit handler as well when awesome restarts.

Arguments:

  • reason_restart Boolean value is true if the signal was sent because of a restart.
screen::change · Inherited from awesome
The output status of a screen has changed.

Arguments:

  • output string String containing which output has changed.
  • connection_state string String containing the connection status of the output: It will be either "Connected", "Disconnected" or "Unknown".
spawn::canceled · Inherited from awesome
For some reason the application aborted startup

Arguments:

  • arg Table which only got the "id" key set
spawn::change · Inherited from awesome
When one of the fields from the ??? table changes

Arguments:

  • arg Table which describes the spawn event
spawn::completed · Inherited from awesome
An application finished starting

Arguments:

  • arg Table which only got the "id" key set
spawn::initiated · Inherited from awesome
When a new client is beginning to start

Arguments:

  • arg Table which describes the spawn event
spawn::timeout · Inherited from awesome
An application started a spawn event but didn't start in time.

Arguments:

  • arg Table which only got the "id" key set

Fields

awesome.version string · Inherited from awesome
The AwesomeWM version.
awesome.release string · Inherited from awesome
The AwesomeWM release name.
awesome.api_level string · Inherited from awesome
The AwesomeWM API level.

By default, this matches the major version (first component of the version).

API levels are used to allow newer version of AwesomeWM to alter the behavior and subset deprecated APIs. Using an older API level than the current major version allows to use legacy rc.lua with little porting. However, they wont be able to use all the new features. Attempting to use a newer feature along with an older API level is not and will not be supported, even if it almost works. Keeping up to date with the newer API levels is highly recommended.

Going the other direction, setting an higher API level allows to take advantage of experimental feature. It will also be much harsher when it comes to deprecation. Setting the API level value beyond current+3 will treat using APIs currently pending deprecation as fatal errors. All new code submitted to the upstream AwesomeWM codebase is forbidden to use deprecated APIs. Testing your patches with mode and the default config is recommended before submitting a patch.

You can use the -l command line option or api-level modeline key to set the API level for your rc.lua. This setting is global and read only, individual modules cannot set their own API level.

awesome.conffile string · Inherited from awesome
The configuration file which has been loaded.
awesome.startup boolean · Inherited from awesome
True if we are still in startup, false otherwise.
awesome.startup_errors string · Inherited from awesome
Error message for errors that occured during startup.
awesome.composite_manager_running boolean · Inherited from awesome
True if a composite manager is running.
awesome.unix_signal table · Inherited from awesome
Table mapping between signal numbers and signal identifiers.
awesome.hostname string · Inherited from awesome
The hostname of the computer on which we are running.
awesome.themes_path string · Inherited from awesome
The path where themes were installed to.
awesome.icon_path string · Inherited from awesome
The path where icons were installed to.
generated by LDoc 1.4.6 Build with 💜 By F0xedb Last updated 2021-05-21 03:30:15