summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDave Davenport <qball@blame.services>2023-01-25 23:15:30 +0100
committerDave Davenport <qball@blame.services>2023-01-25 23:15:30 +0100
commitbc776fd67ca6713adc81b07bda6d73220d3e9dd8 (patch)
tree79a8254d9d6b01bf7229f1607182a7d2d8e1efac
parentdb16c63168556f3c6fe92cb0e9046797a2897202 (diff)
[Doc] More tweaks to get the formulation right.
-rw-r--r--doc/rofi-theme.520
-rw-r--r--doc/rofi-theme.5.markdown19
2 files changed, 25 insertions, 14 deletions
diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5
index 72a64973..a5887a46 100644
--- a/doc/rofi-theme.5
+++ b/doc/rofi-theme.5
@@ -1597,9 +1597,10 @@ hitting accept will activate the first entry.
.RE
+.SH Listview widget
.PP
The listview widget is special container widget.
-It has the following children:
+It has the following fixed children widgets:
.RS
.IP \(bu 2
@@ -1611,8 +1612,11 @@ property.
.RE
.PP
-Each entry displayed by listview captured by a \fB\fCbox\fR called \fB\fCelement\fR\&. Each
-\fB\fCelement\fR can contain the following special widgets:
+These cannot be changed using the \fB\fCchildren\fR property.
+
+.PP
+Each entries displayed by listview are captured by a \fB\fCbox\fR called \fB\fCelement\fR\&.
+An \fB\fCelement\fR widget can contain the following special child widgets:
.RS
.IP \(bu 2
@@ -1625,10 +1629,12 @@ Each entry displayed by listview captured by a \fB\fCbox\fR called \fB\fCelement
.RE
.PP
-A child added with another name is seen as a \fB\fCbox\fR, this can be used to tweak
-how an entry looks when it expands to available space. This can be useful if
-there are multiple columns and on filtering the remaining columns should appear
- centered with a fixed width.
+By default the \fB\fCelement-icon\fR and \fB\fCelement-text\fR child widgets are added to the
+\fB\fCelement\fR\&. This can be modified using the \fB\fCchildren\fR property.
+
+.PP
+A child added with another name is seen as a \fB\fCbox\fR, this can be used as dynamic
+padding to tweak how an entry looks when it expands to available space.
.SS listview text highlight
.PP
diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown
index 65c7c24a..98a70f62 100644
--- a/doc/rofi-theme.5.markdown
+++ b/doc/rofi-theme.5.markdown
@@ -988,24 +988,29 @@ The following properties are currently supported:
Listview requires user input to be unhidden. The list is still present and
hitting accept will activate the first entry.
+## Listview widget
+
The listview widget is special container widget.
-It has the following children:
+It has the following fixed children widgets:
* 0 or more `element` widgets of the type box.
* An optional `scrollbar` widget. This can be enabled using the scrollbar
property.
-Each entry displayed by listview captured by a `box` called `element`. Each
-`element` can contain the following special widgets:
+These cannot be changed using the `children` property.
+
+Each entries displayed by listview are captured by a `box` called `element`.
+An `element` widget can contain the following special child widgets:
* `element-icon`: An icon widget showing the icon associated to the entry.
* `element-text`: A textbox widget showing the text associated to the entry.
* `element-index`: A textbox widget that shows the shortcut keybinding number.
-A child added with another name is seen as a `box`, this can be used to tweak
-how an entry looks when it expands to available space. This can be useful if
-there are multiple columns and on filtering the remaining columns should appear
- centered with a fixed width.
+By default the `element-icon` and `element-text` child widgets are added to the
+`element`. This can be modified using the `children` property.
+
+A child added with another name is seen as a `box`, this can be used as dynamic
+padding to tweak how an entry looks when it expands to available space.
#### listview text highlight