awesome/lib/awful
Brian Sobulefsky 12a3fae456 This commit begins the development of a more appropriate user facing
screenshot API. It extends a prior commit which extended the lower level
content API, which had been a property of the client object but is now
available as a property of the screen object and a method of the root
object.

This commit creates a new screenshot module for the awful module. The
public functions include root(), screen(), client(), snipper(), and
snip(). These take root window, screen, and client window screenshots,
launch an interactive snip tool for cropped screenshots, and take a
cropped screenshot of a geometry passed by argument, respectively. The
init() function is also available for configuration. Using this library
is more appropriate for the average rc.lua.

Since the API is new, this commit does not include any changes to
rc.lua. The developers can modify rc.lua when there is sufficient
confidence in API stability and robustness.

lib/awful/init.lua is modified so that the awful module includes the new
lib/awful/screenshot.lua submodule.

Signed off: Brian Sobulefsky <brian.sobulefsky@protonmail.com>
2022-11-13 16:53:32 -08:00
..
client doc: Add images for awful.client.* functions. 2021-10-18 14:38:37 -07:00
hotkeys_popup awful.hotkeys_popup.widget: Update the property documentation. 2022-08-29 22:49:46 -07:00
layout doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
mouse fix floating snap (#3719) 2022-10-22 14:38:52 -07:00
permissions doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
screen capi: Move from `.data` to `._private` for the property data. 2019-11-09 16:43:12 -05:00
widget textbox: Rename `align` to `halign`. 2022-09-06 16:11:04 -07:00
_compat.lua Fix some spelling errors (#3450) 2021-10-04 19:20:03 -07:00
autofocus.lua rc.lua: Revert moving the sloppy focus to awful.permissions. 2020-02-08 17:59:16 -05:00
button.lua awful.button: Update the property documentation. 2022-08-29 22:49:46 -07:00
client.lua Restore minimized sticky clients (#3709) 2022-09-29 23:12:13 -07:00
completion.lua doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
dbus.lua spelling & grammar issues (#3410) 2021-08-14 23:38:01 -07:00
ewmh.lua awful: Rename awful.ewmh to awful.permissions. 2020-01-11 15:43:30 -08:00
init.lua This commit begins the development of a more appropriate user facing 2022-11-13 16:53:32 -08:00
key.lua awful.key: Update the property documentation. 2022-08-29 22:49:46 -07:00
keyboard.lua doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
keygrabber.lua doc(awful.keygrabber): fix ldoc WARN 2022-09-18 18:22:02 +02:00
menu.lua doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
placement.lua Implement fixes for Luacheck 0.26.1 2022-08-28 16:59:14 -07:00
popup.lua awful.popup: Update the property documentation. 2022-08-29 22:49:47 -07:00
prompt.lua doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
remote.lua awful.remote: Protect against error(nil) (#2748) 2019-04-14 12:34:52 -04:00
root.lua keygrabber: Remove the hardcoded way to add keybindings. 2019-11-09 16:43:53 -05:00
rules.lua rules: Move `awful.rules` to `ruled.client`. 2020-01-19 02:58:37 -05:00
screen.lua awful.screen: Update the property documentation. 2022-08-29 22:49:47 -07:00
screenshot.lua This commit begins the development of a more appropriate user facing 2022-11-13 16:53:32 -08:00
spawn.lua doc: Add a mandatory `@noreturn` for functions and methods. 2022-08-29 22:49:45 -07:00
startup_notification.lua Add beautiful property to control busy cursor during spawn 2017-03-01 21:57:59 +01:00
tag.lua awful.tag: Update the property documentation. 2022-08-29 22:49:47 -07:00
titlebar.lua doc(awful.titlebar): fix ldoc WARN 2022-09-18 18:22:52 +02:00
tooltip.lua awful.tooltip: Update the property documentation. 2022-08-29 22:49:47 -07:00
util.lua doc: Add documentation linting and fix all issues it found. 2022-08-29 22:48:54 -07:00
wallpaper.lua awful.wallpaper: Update the property documentation. 2022-08-29 22:49:47 -07:00
wibar.lua awful.wibar: Update the property documentation. 2022-08-29 22:49:47 -07:00
wibox.lua doc: Add missing C-object documentation and fix some papercuts. 2018-07-25 18:26:11 -04:00