From 8220dbb513fe2cf9051bb685eb19784f8e3f4f2f Mon Sep 17 00:00:00 2001
From: Benjamin Voisin <benjamin.voisin@ens-rennes.fr>
Date: Tue, 28 May 2024 20:42:47 +0200
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20add=20a=20wayba-menu=20entry=20f?=
 =?UTF-8?q?or=20documenting=20popup=20menus.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 man/waybar-menu.5.scd | 111 ++++++++++++++++++++++++++++++++++++++++++
 meson.build           |   1 +
 2 files changed, 112 insertions(+)
 create mode 100644 man/waybar-menu.5.scd

diff --git a/man/waybar-menu.5.scd b/man/waybar-menu.5.scd
new file mode 100644
index 00000000..10484e41
--- /dev/null
+++ b/man/waybar-menu.5.scd
@@ -0,0 +1,111 @@
+waybar-menu(5)
+
+# NAME
+
+waybar - menu property
+
+# OVERVIEW
+
+
+Some modules support a 'menu', which allows to have a popup menu whan a defined
+click is done over the module.
+
+# PROPERTIES
+
+A module that implements a 'menu' needs 3 properties defined in its config :
+
+*menu*: ++
+	typeof: string ++
+	Action that popups the menu. The possibles actions are :
+
+[- *Option*
+:- *Description*
+|[ *on-click*
+:< When you left-click on the module
+|[ *on-click-release*
+:< When you release left button on the module
+|[ *on-double-click*
+:< When you double left click on the module
+|[ *on-triple-click*
+:< When you triple left click on the module
+|[ *on-click-middle*
+:< When you middle click on the module using mousewheel
+|[ *on-click-middle-release*
+:< When you release mousewheel button on the module
+|[ *on-double-click-middle*
+:< When you double middle click on the module
+|[ *on-triple-click-middle*
+:< When you triple middle click on the module
+|[ *on-click-right*
+:< When you right click on the module using
+|[ *on-click-right-release*
+:< When you release right button on the module
+|[ *on-double-click-right*
+:< When you double right click on the module
+|[ *on-triple-click-right*
+:< When you triple middle click on the module
+|[ *on-click-backward*
+:< When you  click on the module using mouse backward button
+|[ *on-click-backward-release*
+:< When you release mouse backward button on the module
+|[ *on-double-click-backward*
+:< When you double click on the module using mouse backward button
+|[ *on-triple-click-backward*
+:< When you triple click on the module using mouse backawrd button
+|[ *on-click-forward*
+:< When you  click on the module using mouse forward button
+|[ *on-click-forward-release*
+:< When you release mouse forward button on the module
+|[ *on-double-click-forward*
+:< When you double click on the module using mouse forward button
+|[ *on-triple-click-forward*
+:< When you triple click on the module using mouse forward button
+
+*menu-file*: ++
+	typeof: string ++
+	Location of the menu descriptor file. There need to be an element of type
+	GtkMenu with id *menu*.
+
+*menu-actions*: ++
+	typeof: array ++
+	The actions corresponding to the buttons of the menu. The identifiers of
+	each actions needs to exists as an id in the 'menu-file' for it to be linked
+	properly.
+
+# EXAMPLE
+
+```
+"custom/power": {
+    "format" : "⏻ ",
+    "tooltip": false,
+    "menu": "on-click",
+    "menu-file": "~/.config/waybar/power_menu.xml",
+    "menu-actions": {
+        "shutdown": "shutdown",
+        "reboot": "reboot",
+	"suspend": "systemctl suspend",
+	"hibernate": "systemctl hibernate",
+    },
+},
+```
+
+# STYLING MENUS
+
+- *menu*
+  Style for the menu
+
+- *menuitem*
+  Style for items in the menu
+
+# EXAMPLE:
+
+```
+menu {
+	border-radius: 15px;
+	background: #161320;
+	color: #B5E8E0;
+}
+menuitem {
+	border-radius: 15px;
+}
+```
diff --git a/meson.build b/meson.build
index a57b17f8..56b772a5 100644
--- a/meson.build
+++ b/meson.build
@@ -192,6 +192,7 @@ man_files = files(
     'man/waybar-idle-inhibitor.5.scd',
     'man/waybar-image.5.scd',
     'man/waybar-states.5.scd',
+    'man/waybar-menu.5.scd',
     'man/waybar-temperature.5.scd',
 )