Commit Graph

2201 Commits

Author SHA1 Message Date
Emmanuel Lepage Vallee 86d1b1c22c doc: Add a mandatory `@noreturn` for functions and methods.
The goal is to catch cases where the return value exists, but is
forgotten. There was a large enough number of them to turn this
into a real check. Initially, I just wanted to implement it to fix
the problems, then delete the code. But since this is so common, I
think it is worth the annoyance.
2022-08-29 22:49:45 -07:00
Emmanuel Lepage Vallee 4bd90f0f35 doc: Add documentation linting and fix all issues it found. 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee f3987f43b6 doc: More proof reading fixes. 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee af3e62ae64 tasklist: Fix `disable_icon`.
It regressed when the tasklist switched to a template by default.
This was done to support the icon size.

Fix #3178
2022-08-29 22:48:54 -07:00
Grzegorz Bednarski 1f5b759306 Support minimized client property in tasklist icons (#3526) 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee fb8f7cfadd hotkey/calendar: Fix rendering when the theme color is a pattern.
It blew up.
2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 75ab366769 doc: Proof reading fixes.
* Rendering problems
 * Incomplete type information
 * Obsolete type information
 * Missing type information
 * Missing return value
 * Incomplete return value type
2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 11a7c8c47b doc: Fix the `layoutbox` doc.
It didn't have a constructor.
2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee 69ab73aa23 doc: Fix a popup doc issue.
The variable name wasn't in the @param string, so it was called "The".
2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee dd7492fa7c doc: Fix some broken links in the tasklist doc. 2022-08-29 22:48:54 -07:00
Emmanuel Lepage Vallee caad1bec55 tooltip: Make the `args` optional.
It would render a non-useful error when calling `awful.tooltip()`.
2022-08-29 22:48:36 -07:00
Emmanuel Lepage Vallee 935da05be4 layoutlist: Sanitize the color when building Pango strings.
This was aready done in the `tasklist` and `taglist`.
2022-08-29 22:48:36 -07:00
Emmanuel Lepage Vallee 8f71ef6dff doc: Document the tasklist widget. 2022-08-29 22:48:35 -07:00
Emmanuel Lepage Vallee c7ed176586 tasklist: Fix `disable_icon`.
It regressed when the tasklist switched to a template by default.
This was done to support the icon size.

Fix #3178
2022-08-29 22:47:55 -07:00
Emmanuel Lepage Vallee b8dbba34db taglist/tasklist: Fix the fallback font.
When beautiful.font isn't set, it fell back to "". That value isn't
actually the same as the "default" Pango font. Better use `nil`.
2022-08-29 22:47:55 -07:00
Emmanuel Lepage Vallee 396bddb946 layoutlist: Add a `count` property.
Because it was added to the `taglist` and `tasklist` and their API
somewhat mirror each other.
2022-08-29 22:47:55 -07:00
Emmanuel Lepage Vallee 798d31881d taglist: Add a `count` property.
This is mostly for its signal handler. It will allow to replace the
template or layout based on the number of tags.
2022-08-29 22:47:55 -07:00
Emmanuel Lepage Vallee b11a8fb52c tasklist: Add a `count` property.
This is mostly for the signal handler. It will allow to do things
like replace the template or layout based on the number of clients.
2022-08-29 22:47:55 -07:00
Emmanuel Lepage Vallee 70c6821997 tasklist: Convert to a real widget.
Previously, it was monkey-patching the input layout object. This will
allow to replace the laoyut at runtime. For example, switching from
`fixed.horizontal` to a grid when the number of client gets too large.
2022-08-29 22:47:55 -07:00
Emmanuel Lepage Vallee a3b7532056 taglist: Expose more properties.
They were passed in the constructor, but could not be changed.
2022-08-29 22:47:55 -07:00
Emmanuel Lepage Vallee df59f5bdd3 taglist: Convert into a real widget.
It no longer monkey-patch the input layout widget. This allows the
layout to be replaced at runtime.
2022-08-29 22:47:55 -07:00
Emmanuel Lepage Vallee 2f3bce00e6 tasklist: Refactor to base a normal widget.
It was previously monkey-patching the input layout object into
the final tasklist.

This is a breaking change, but affects undocumented behaviors. By
doing this, it becomes possible to expose the properties in the
public API. This, in turn, allows to document them. Right now,
the documentation is very vague on some behaviors.
2022-08-29 22:47:55 -07:00
Emmanuel Lepage Vallee 1601c6890b keygrabber: Document 5 deprecated, but still honored, method arguments.
As pointed out by @sclu1034, some users might actually pass the return
values of a function with multiple returns. This would cause some
confusing behavior. Documenting previous mistakes is in this case better
than hiding them.
2022-08-28 17:13:52 -07:00
Emmanuel Lepage Vallee 75019c3f6f Implement fixes for Luacheck 0.26.1
* Rename or mute parameters starting with _
 * Replace `not (>=)` with `<`
2022-08-28 16:59:14 -07:00
Kamack38 05a405b38b
feat(hotkeys: widget): add 3 new labels for keyboard keys (#3668)
Signed-off-by: kamack38 <64226248+kamack38@users.noreply.github.com>
2022-08-18 21:22:16 +02:00
Matthias Paulmier b7bac1dc76
awful.widget.prompt: Properly take into account `with_shell` arg (#3659) 2022-07-12 08:53:34 -07:00
Actionless Loveless 9ca7bb487a
style(beautiful: gtk; hotkeys_popup): make new luacheck a bit happier (#3651) 2022-06-30 08:32:45 -07:00
A.I c3c41bed2f
pass tag icon directly to imagebox
so that svg icons can be rendered with rsvg
2022-06-17 23:17:50 +08:00
Grumph 3a542219f3
Fix awful.keygrabber:add_keybinding function (#3568)
* Check the correct variable

* Fix table access

In every other use of _private.keybindings in this file, the key is a
string, not an awful.key

* Simplify code

key.key is always defined

* Add tests

* add(spec) add_keybinding unit test

* Revert "Add tests"

This reverts commit 808b17cd5c.

Co-authored-by: Aire-One <aireone@aireone.xyz>
2022-05-29 13:10:29 -07:00
Emmanuel Lepage Vallée be69e347fa
Merge pull request #3591 from actionless/spawn-doc-spaces
doc(awful: spawn): fix spaces
2022-05-29 12:45:09 -07:00
Actionless Loveless c539e0e435
hotkeys_popup: expose labels and remove unused backspace translation (#3585)
the actual key is BackSpace, not Backspace, so this translation was always unused


Co-authored-by: Lucas Schwiderski <4508454+sclu1034@users.noreply.github.com>
2022-03-21 18:09:49 +01:00
actionless 1d228a13ab doc(awful: spawn): proper quotes for an arg name 2022-03-20 18:57:12 +01:00
actionless 3d94bf0738 doc(awful: spawn): fix spaces 2022-03-20 18:57:12 +01:00
sarubo 9895aeb0d5
fix(placement) bad argument to 'field' (#3572)
RectangleInt must use integer
Remove float from RectangleInt
2022-02-25 19:34:51 +01:00
Grzegorz Bednarski f353499230
Support minimized client property in tasklist icons (#3526) 2021-12-21 11:48:53 -08:00
sarubo 8d61790be7 doc: Add the markup example of popup_calendar
Refer to tests/examples/awful/widget/calendar_popup/default.lua
2021-11-21 23:49:46 +09:00
sarubo 03e437e32a calendar_popup: Fix markup not working 2021-11-21 23:42:00 +09:00
Emmanuel Lepage Vallée d5fae3f3dc
Merge pull request #3478 from Elv13/better_shims
Fix a few sequences template bugs
2021-10-28 12:27:11 -07:00
Emmanuel Lepage Vallée c8ada80fb3
Merge pull request #3484 from Elv13/2012_misc_fixes
Miscellaneous small bug fixes
2021-10-28 12:26:47 -07:00
Emmanuel Lepage Vallee 5069f5c2ed client.floating: Add a missing signal connection.
The `fullscreen` state does affect the outcome of the state, so
it needs to be connected for request::border to be sent.
2021-10-27 20:08:15 -07:00
Emmanuel Lepage Vallee 7d6892992c client: Change the `relative_move` behavior.
The old behavior would move the client when `nil` was passed by
an almost arbitrary value. It would most of the time go off screen.

While this is a behavior change, what it replaces was so broken I
doubt anybody actually used `nil` in `relative_move`.
2021-10-27 18:30:30 -07:00
Emmanuel Lepage Vallee 146a9c3166 permission: Fix hiding the border for maximized clients.
When the theme variables were moved to the backend instead of `rc.lua`,
some magic was added to disable them if the user set the border. However,
some undocumented `awful.placement` code also set them and turned off
the theme variables. So it worked *once* then stopped working.
2021-10-27 13:41:11 -07:00
Emmanuel Lepage Vallee 907053f31a titlebar: Implement setting the font (as documented, but unimplemented)
It was documented to exist, but didn't.
2021-10-27 13:41:11 -07:00
Emmanuel Lepage Vallee c7208b4bb0 layoutlist: Rename the constructor arg from `layout` to `base_layout`.
The documentation examples already called it that way.
2021-10-27 13:41:11 -07:00
Emmanuel Lepage Vallee 440d1560a3 layoutlist: Fix the `layout` consturctor parameter.
If set, it would override some important widget methods and
explode.
2021-10-27 13:41:10 -07:00
Emmanuel Lepage Vallee 2f8413acbc layoutlist: Use `layoutlist_spacing` instead of `tasklist_spacing`.
Old copy/paste bug.
2021-10-27 13:38:48 -07:00
Sergey fcef95b1f0 Removing duplicating descriptions of screen properties as read only
Removed "Immutable: true" from readonly properties descriptions.
2021-10-27 14:52:36 -04:00
Sergey 212ec72236 Removing read only from properties descriptions. It's set with ldoc tag now. 2021-10-27 14:52:36 -04:00
Sergey 6c3d233893 Mark readonly properties for screen 2021-10-27 14:52:36 -04:00
Sergey 43ff4e07ad Marking readonly properties for client 2021-10-27 14:52:36 -04:00