From 4a4864bb75db713f35f8668093f0da488fd93432 Mon Sep 17 00:00:00 2001
From: Emmanuel Lepage Vallee <elv1313@gmail.com>
Date: Sat, 11 Feb 2017 15:36:35 -0500
Subject: [PATCH] doc: Add another declarative syntax example

Better show the composite/encapsulated widgets
---
 docs/03-declarative-layout.md                 |  4 +
 .../widget/progressbar/encapsulation.lua      | 82 +++++++++++++++++++
 2 files changed, 86 insertions(+)
 create mode 100644 tests/examples/wibox/widget/progressbar/encapsulation.lua

diff --git a/docs/03-declarative-layout.md b/docs/03-declarative-layout.md
index a25a34e1..c577d5ae 100644
--- a/docs/03-declarative-layout.md
+++ b/docs/03-declarative-layout.md
@@ -56,6 +56,10 @@ there is an `s` variable represent to define the current screen. Any Lua
 logic expression can be used as long as it returns a valid widget or a
 declarative layout, or `nil`.
 
+### Composite widgets
+
+@DOC_wibox_widget_progressbar_encapsulation_EXAMPLE@
+
 
 ### Define widgets inline and place them
 
diff --git a/tests/examples/wibox/widget/progressbar/encapsulation.lua b/tests/examples/wibox/widget/progressbar/encapsulation.lua
new file mode 100644
index 00000000..8ad14b9f
--- /dev/null
+++ b/tests/examples/wibox/widget/progressbar/encapsulation.lua
@@ -0,0 +1,82 @@
+local parent = ... --DOC_NO_USAGE --DOC_NO_DASH --DOC_HIDE
+local wibox  = require("wibox") --DOC_HIDE
+local color  = require("gears.color") --DOC_HIDE
+local beautiful = require("beautiful") --DOC_HIDE
+
+local grad1 = color{ type = "linear", from = { 0, 0 }, to = { 20, 0 }, --DOC_HIDE
+    stops = { { 0, "#00ff00" }, { 1, "#00ffff" }}} --DOC_HIDE
+local grad2 = color{ type = "linear", from = { 0, 0 }, to = { 20, 0 }, --DOC_HIDE
+    stops = { { 0, "#ffff00" }, { 1, "#ff00ff" }}} --DOC_HIDE
+local grad3 = color{ type = "linear", from = { 0, 0 }, to = { 20, 0 }, --DOC_HIDE
+    stops = { { 0, "#ff0000" }, { 1, "#0000ff" }}} --DOC_HIDE
+
+    -- The progressbars will be on top of each other
+     local mycpubar1 = wibox.widget {
+        { value  = 0.2, color = grad1,
+            widget = wibox.widget.progressbar },
+        { value  = 0.4, color = grad2,
+            widget = wibox.widget.progressbar },
+        { value  = 0.6, color = grad3,
+            widget = wibox.widget.progressbar },
+        layout = wibox.layout.flex.vertical,
+     }
+
+    -- Now, add a rotate container, the height will become the width.
+    -- It act as if the `wibox.layout.flex.vertical` was
+    -- `wibox.layout.flex.horizontal`
+     local mycpubar2 = wibox.widget {
+        {
+            { value  = 0.2, color = grad1,
+                widget = wibox.widget.progressbar },
+            { value  = 0.4, color = grad2,
+                widget = wibox.widget.progressbar },
+            { value  = 0.6, color = grad3,
+                widget = wibox.widget.progressbar },
+            layout = wibox.layout.flex.vertical,
+        },
+        direction = 'east',
+        widget    = wibox.container.rotate
+     }
+
+parent:add(wibox.widget { --DOC_HIDE
+           { --DOC_HIDE
+               { --DOC_HIDE
+                   markup = "<b>mycpubar1</b>", --DOC_HIDE
+                   widget = wibox.widget.textbox --DOC_HIDE
+               }, --DOC_HIDE
+               { --DOC_HIDE
+                   { --DOC_HIDE
+                       mycpubar1, --DOC_HIDE
+                       margins = 4, --DOC_HIDE
+                       layout = wibox.container.margin --DOC_HIDE
+                   }, --DOC_HIDE
+                   margins = 1, --DOC_HIDE
+                   color  = beautiful.border_color, --DOC_HIDE
+                   layout = wibox.container.margin, --DOC_HIDE
+               }, --DOC_HIDE
+               layout = wibox.layout.fixed.vertical --DOC_HIDE
+           }, --DOC_HIDE
+           { --DOC_HIDE
+               { --DOC_HIDE
+                   markup = "<b>mycpubar2</b>", --DOC_HIDE
+                   widget = wibox.widget.textbox --DOC_HIDE
+               }, --DOC_HIDE
+               { --DOC_HIDE
+                   { --DOC_HIDE
+                       mycpubar2, --DOC_HIDE
+                       margins = 4, --DOC_HIDE
+                       layout = wibox.container.margin --DOC_HIDE
+                   }, --DOC_HIDE
+                   margins = 1, --DOC_HIDE
+                   color  = beautiful.border_color, --DOC_HIDE
+                   layout = wibox.container.margin, --DOC_HIDE
+               }, --DOC_HIDE
+               layout = wibox.layout.fixed.vertical --DOC_HIDE
+           }, --DOC_HIDE
+           layout = wibox.layout.flex.horizontal --DOC_HIDE
+       }) --DOC_HIDE
+
+return 500, 40 --DOC_HIDE
+
+
+--DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80