]> git.madduck.net Git - etc/awesome.git/blob - calendar.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

b06c453872c983b469967e031b911ebae68f815c
[etc/awesome.git] / calendar.md
1 [<- widgets](https://github.com/copycat-killer/lain/wiki/Widgets)
2
3 Attaches a calendar notification to a widget.
4
5     lain.widgets.calendar:attach(widget, args)
6
7 - Left click: switch to previous month.
8 - Right click: switch to next month.
9
10 `args` is an optional table which can contain:
11
12 Variable | Meaning | Type | Default
13 --- | --- | --- | ---
14 `icons` | Path to calendar icons | string | [lain/icons/cal/white](https://github.com/copycat-killer/lain/tree/master/icons/cal/white)
15 `font_size` | Calendar font size | int | 12
16 `fg` | Calendar foreground color | string | `beautiful.fg_normal`
17 `bg` | Calendar background color | string | `beautiful.bg_normal`
18 `position` | Calendar position | string | "top_right"
19
20 `position` possible values are defined [here](http://awesome.naquadah.org/doc/api/modules/naughty.html#notify).
21
22 Notification will show an icon displaying current day, and formatted output
23 from ``cal`` with current day highlighted.
24
25 You can call the notification with a key binding like this:
26
27     awful.key({ altkey }, "c", function () lain.widgets.calendar:show(7) end),
28
29 where ``altkey = "Mod1"`` and ``show`` argument is an optional integer, meaning timeout seconds.
30
31 **Note that** this widget exploits ``cal`` to do the alignment, in order to avoid more dozens of code lines, but this requires that your system font is monospaced.