From a39f66e1c6e802cb269a176208c9f0d1d8c3730e Mon Sep 17 00:00:00 2001
From: Emmanuel Lepage Vallee <elv1313@gmail.com>
Date: Sun, 9 Aug 2020 23:33:59 -0700
Subject: [PATCH] doc: Add an example for the client struts.

---
 objects/client.c                 |  7 ++++
 tests/examples/screen/struts.lua | 60 ++++++++++++++++++++++++++++++++
 2 files changed, 67 insertions(+)
 create mode 100644 tests/examples/screen/struts.lua

diff --git a/objects/client.c b/objects/client.c
index 7238263c..581288ed 100644
--- a/objects/client.c
+++ b/objects/client.c
@@ -1224,6 +1224,13 @@ lua_class_t client_class;
  *
  * This corresponds to EWMH's `_NET_WM_STRUT` and `_NET_WM_STRUT_PARTIAL`.
  *
+ * In the example below, 2 object affect the workarea (using their struts):
+ *
+ * * The top wibar add a `top=24`
+ * * The bottom-left client add `bottom=100, left=100`
+ *
+ * @DOC_screen_struts_EXAMPLE@
+ *
  * @tparam table struts A table with new strut values, or none.
  * @treturn table A table with strut values.
  * @method struts
diff --git a/tests/examples/screen/struts.lua b/tests/examples/screen/struts.lua
new file mode 100644
index 00000000..dbb46755
--- /dev/null
+++ b/tests/examples/screen/struts.lua
@@ -0,0 +1,60 @@
+--DOC_GEN_IMAGE --DOC_NO_USAGE --DOC_ASTERISK
+
+screen[1]._resize {x = 0, width = 640, height = 480} --DOC_HIDE
+
+local awful = { --DOC_HIDE
+    wibar = require("awful.wibar"), --DOC_HIDE
+    tag = require("awful.tag"), --DOC_HIDE
+    tag_layout = require("awful.layout.suit.tile") --DOC_HIDE
+}
+
+    -- Wibars and docked clients are the main users of the struts.
+    local wibar = awful.wibar {
+        position = "top",
+        height   = 24, -- this will set the wibar won :struts() to top=24
+    }
+
+awful.tag.add("1", { --DOC_HIDE
+    screen   = screen[1], --DOC_HIDE
+    selected = true, --DOC_HIDE
+    layout   = awful.tag_layout.right, --DOC_HIDE
+    gap      = 4 --DOC_HIDE
+}) --DOC_HIDE
+
+local c = client.gen_fake{} --DOC_HIDE
+
+    -- This is the client in the bottom left.
+    c.name     = "w. struts"
+    c.floating = true
+
+--DOC_NEWLINE
+
+    c:geometry {
+        x      = 0,
+        y      = 380,
+        height = 100,
+        width  = 100,
+    }
+
+--DOC_NEWLINE
+
+    c:struts {
+        left   = 100,
+        bottom = 100
+    }
+
+local clients = { --DOC_HIDE
+    ['w. struts'] = c, --DOC_HIDE
+    ['client #1'] = client.gen_fake{}, --DOC_HIDE
+    ['client #2'] = client.gen_fake{}, --DOC_HIDE
+    ['client #3'] = client.gen_fake{}, --DOC_HIDE
+} --DOC_HIDE
+
+return { --DOC_HIDE
+    factor                = 2   , --DOC_HIDE
+    show_boxes            = true, --DOC_HIDE
+    draw_wibar            = wibar, --DOC_HIDE
+    draw_clients          = clients, --DOC_HIDE
+    display_screen_info   = false, --DOC_HIDE
+    draw_struts           = true, --DOC_HIDE
+} --DOC_HIDE