diff --git a/docs/common/cursor_c.ldoc b/docs/common/cursor_c.ldoc
index 6b595973d..55ac684cc 100644
--- a/docs/common/cursor_c.ldoc
+++ b/docs/common/cursor_c.ldoc
@@ -1,80 +1,80 @@
- *
+
+ *
num_glyphs
+ *
arrow
+ *
based_arrow_down
+ *
based_arrow_up
+ *
boat
+ *
bogosity
+ *
bottom_left_corner
+ *
bottom_right_corner
+ *
bottom_side
+ *
bottom_tee
+ *
box_spiral
+ *
center_ptr
+ *
circle
+ *
clock
+ *
coffee_mug
+ *
cross
+ *
crosshair
+ *
cross_reverse
+ *
cursor
+ *
diamond_cross
+ *
dotbox
+ *
dot
+ *
double_arrow
+ *
draft_large
+ *
draft_small
+ *
draped_box
+ *
exchange
+ *
fleur
+ *
gobbler
+ *
gumby
+ *
hand
+ *
hand
+ *
heart
+ *
icon
+ *
iron_cross
+ *
leftbutton
+ *
left_ptr
+ *
left_side
+ *
left_tee
+ *
ll_angle
+ *
lr_angle
+ *
man
+ *
middlebutton
+ *
mouse
+ *
pencil
+ *
pirate
+ *
plus
+ *
question_arrow
+ *
rightbutton
+ *
right_ptr
+ *
right_side
+ *
right_tee
+ *
rtl_logo
+ *
sailboat
+ *
sb_down_arrow
+ *
sb_h_double_arrow
+ *
sb_left_arrow
+ *
sb_right_arrow
+ *
sb_up_arrow
+ *
sb_v_double_arrow
+ *
shuttle
+ *
sizing
+ *
spider
+ *
spraycan
+ *
star
+ *
target
+ *
tcross
+ *
top_left_arrow
+ *
top_left_corner
+ *
top_right_corner
+ *
top_side
+ *
top_tee
+ *
trek
+ *
ul_angle
+ *
umbrella
+ *
ur_angle
+ *
watch
+ *
xterm
+ *
| bilinear | Linear interpolation in two dimensions |
--
--
--- The image used in the example below has a resolution of 32x22 and is intentionally
--- blocky to highlight the difference. It is zoomed by a factor of 3.
+-- The image used in the example below has a resolution of 32x22 and is
+-- intentionally blocky to highlight the difference.
+-- It is zoomed by a factor of 3.
--
-- @DOC_wibox_widget_imagebox_scaling_quality_EXAMPLE@
--
-- @property scaling_quality
--- @tparam string scaling_quality Either `fast`, `good`, `best`, `nearest` or `bilinear`.
+-- @tparam string scaling_quality Either `"fast"`, `"good"`, `"best"`,
+-- `"nearest"` or `"bilinear"`.
-- @propemits true false
-- @see resize
-- @see horizontal_fit_policy
diff --git a/lib/wibox/widget/textbox.lua b/lib/wibox/widget/textbox.lua
index b4019381f..f51810879 100644
--- a/lib/wibox/widget/textbox.lua
+++ b/lib/wibox/widget/textbox.lua
@@ -222,17 +222,22 @@ function textbox:get_text()
return self._private.layout.text
end
---- Set a textbox ellipsize mode.
+--- Set the text ellipsize mode.
--
-- Valid values are:
--
--- * **start**
--- * **middle**
--- * **end**
+-- * `"start"`
+-- * `"middle"`
+-- * `"end"`
+-- * `"none"`
+--
+-- See Pango for additional details:
+-- [Layout.set_ellipsize](https://docs.gtk.org/Pango/method.Layout.set_ellipsize.html)
+--
+--@DOC_wibox_widget_textbox_ellipsize_EXAMPLE@
--
-- @property ellipsize
--- @tparam string mode Where should long lines be shortened? "start", "middle"
--- or "end".
+-- @tparam string mode The ellipsize mode.
-- @propemits true false
function textbox:set_ellipsize(mode)
diff --git a/mousegrabber.c b/mousegrabber.c
index cc7be5857..31e0c3457 100644
--- a/mousegrabber.c
+++ b/mousegrabber.c
@@ -82,7 +82,7 @@ mousegrabber_handleevent(lua_State *L, int x, int y, uint16_t mask)
* The function is called with one argument:
* a table containing modifiers pointer coordinates.
*
- * The list of valid cusrors are:
+ * The list of valid cursors is:
*
*@DOC_cursor_c_COMMON@
*
diff --git a/tests/examples/wibox/container/defaults/radialprogressbar.lua b/tests/examples/wibox/container/defaults/radialprogressbar.lua
index 6d59a8914..a9f3c476d 100644
--- a/tests/examples/wibox/container/defaults/radialprogressbar.lua
+++ b/tests/examples/wibox/container/defaults/radialprogressbar.lua
@@ -1,6 +1,6 @@
---DOC_HIDE_ALL
+--DOC_HIDE_START
--DOC_GEN_IMAGE
-local wibox = require("wibox")
+local wibox = require("wibox")
return {
text = "Before",
@@ -9,6 +9,7 @@ return {
widget = wibox.widget.textbox,
},
{
+--DOC_HIDE_END
{
{
text = "After",
@@ -16,13 +17,14 @@ return {
valign = "center",
widget = wibox.widget.textbox,
},
- value = 0.5,
- max_value = 1,
- min_value = 0,
- widget = wibox.container.radialprogressbar
+ value = 0.5,
+ max_value = 1,
+ min_value = 0,
+ widget = wibox.container.radialprogressbar
},
+--DOC_HIDE_START
margins = 5,
layout = wibox.container.margin
}
---DOC_HIDE vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
+-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80
diff --git a/tests/examples/wibox/widget/textbox/ellipsize.lua b/tests/examples/wibox/widget/textbox/ellipsize.lua
new file mode 100644
index 000000000..f684a59e9
--- /dev/null
+++ b/tests/examples/wibox/widget/textbox/ellipsize.lua
@@ -0,0 +1,59 @@
+--DOC_GEN_IMAGE --DOC_HIDE
+
+--DOC_HIDE_START
+local parent = ...
+local wibox = require("wibox")
+
+local widget = function(inner)
+ return wibox.widget {
+ {
+ {
+ inner,
+ margins = 5,
+ widget = wibox.container.margin,
+ },
+ border_width = 2,
+ widget = wibox.container.background,
+ },
+ strategy = "max",
+ height = 25,
+ widget = wibox.container.constraint,
+ }
+end
+
+local widgets = {
+--DOC_HIDE_END
+
+widget{
+ text = "This is a very long text, that cannot be displayed fully.",
+ ellipsize = "start",
+ widget = wibox.widget.textbox,
+},
+
+widget{
+ text = "This is a very long text, that cannot be displayed fully.",
+ ellipsize = "end",
+ widget = wibox.widget.textbox,
+},
+
+widget{
+ text = "This is a very long text, that cannot be displayed fully.",
+ ellipsize = "middle",
+ widget = wibox.widget.textbox,
+},
+
+widget{
+ text = "This is a very long text, that cannot be displayed fully.",
+ ellipsize = "none",
+ valign = "top",
+ widget = wibox.widget.textbox,
+}
+
+--DOC_HIDE_START
+}
+
+parent:set_children(widgets)
+
+return parent:fit({ dpi = 96 }, 150, 200)
+
+-- vim: filetype=lua:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:textwidth=80