Commit Graph

19 Commits

Author SHA1 Message Date
Emmanuel Lepage Vallee 9207b78f81 doc: Add `awful.screenshot` examples. 2022-11-13 17:35:32 -08:00
Emmanuel Lepage Vallee d92a1c498b awful.screenshot: Allow to export widgets instead of files.
Useful for alt-tab widgets and CDE / E16 style Iconified clients.
2022-11-13 17:35:32 -08:00
Emmanuel Lepage Vallee f55a334972 awful.screenshot: Add a delay feature.
This can also act as an auto-save feature if the delay is zero. It
also adds more signals. These signals are intended for creating
notifications. `awful` cannot safely depend on `naughty`, so this
intergration will have to be done by the users.
2022-11-13 17:35:32 -08:00
Emmanuel Lepage Vallee b7dcece40c awful.screenshot: Add keyboard support. 2022-11-13 16:53:32 -08:00
Emmanuel Lepage Vallee aca9136b02 screenshot: Cleanup the API.
* Fix all warnings
 * Make indentation consistent across the file
 * Simplify/unify the validation (use `error()` rather
   than try to silently fix problems, move to setters)
   and fallback code (move to the getters rather than...
   everywhere)
 * Write the documentation
 * Finish the tests
 * Remove unnecessary constructors
 * Remove path builder because it belongs in
   `gears.filesystem` and wasn't really used anyway
 * Add more properties and a beautiful variable to
   replace `set_defaults` and hardcoded values.
 * Replace callbacks with signals (common pattern
   in modern AwesomeWM APIs)
 * Moved from `os.date` to GLib and some boilerplate
   code to make Debian devs less angry
 * Changed the way the snipping tool selection wibox works.
   Now it freeze the screenshot before the selection.
   The old way had a bunch of side effects for things
   like Qt/GTK comboboxes. It also could crash.
2022-11-13 16:53:32 -08:00
Brian Sobulefsky 37ec7cd173 Clean up logging from Lua 5.1 and 5.2 error debug. Add a little more
test coverage.
2022-11-13 16:53:32 -08:00
Brian Sobulefsky 9d9fedf945 Likely solution to lua 5.1 and 5.2 bug. 2022-11-13 16:53:32 -08:00
Brian Sobulefsky e8584f47b4 Debugging lua 5.1, lua 5.2 error. 2022-11-13 16:53:32 -08:00
Brian Sobulefsky fb77f90959 Zeroing in on lua 5.1 and 5.2 bug on GitHub. 2022-11-13 16:53:32 -08:00
Brian Sobulefsky ea3f82bdf0 Debugging Lua 5.1 and 5.2 on GitHub. 2022-11-13 16:53:32 -08:00
Brian Sobulefsky 1eb8371341 Error message addition to debug lua 5.1 and 5.2 out on GitHub jobs. 2022-11-13 16:53:32 -08:00
Brian Sobulefsky 75943e788b Add some more test coverage to get this PR to the requisite 91%. 2022-11-13 16:53:32 -08:00
Brian Sobulefsky 8f7750e6f2 Add tests for the snipper tool and the snip (defined geometry) routine
to increase test coverage.
2022-11-13 16:53:32 -08:00
Brian Sobulefsky 52e0242ec6 Move some filesystem related logic in the screenshot lib to gears
request from awesome maintainers.
2022-11-13 16:53:32 -08:00
Brian Sobulefsky 1fdefad750 Fix the failed test case and some issues regarding variable naming.
There will still be one more commit to replace some of the screenshot
module code with available functionality from gears (e.g. the filesystem
module).
2022-11-13 16:53:32 -08:00
Brian Sobulefsky 5a7faa0010 Develop the awful.screenshot module into an object oriented format. Add
tests for the awful.screenshot module.
2022-11-13 16:53:32 -08:00
Brian Sobulefsky efc9adae7c Corrections to the lua documentation comment syntax. 2022-11-13 16:53:32 -08:00
Brian Sobulefsky 18ee0d6bf7 Add luadoc comments for awful.screenshot.init and fix a typo in the
mousegrabber callback (use the filename convenience variable 'fname').
2022-11-13 16:53:32 -08:00
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