diff options
| author | Dave Davenport <qball@blame.services> | 2023-01-25 22:55:04 +0100 |
|---|---|---|
| committer | Dave Davenport <qball@blame.services> | 2023-01-25 22:55:04 +0100 |
| commit | 7a1eb91329717edc792431829dee59872964307b (patch) | |
| tree | ef52cd455c8d7f1ac9a4620c0a0148871e6949bd | |
| parent | 48e5478cebe25fa1c7531b84733e6c97bf885c62 (diff) | |
[Doc] Try to clarify the children situation for the listview widget.
| -rw-r--r-- | doc/rofi-theme.5 | 17 | ||||
| -rw-r--r-- | doc/rofi-theme.5.markdown | 15 |
2 files changed, 30 insertions, 2 deletions
diff --git a/doc/rofi-theme.5 b/doc/rofi-theme.5 index 98f150b9..d77b8dcc 100644 --- a/doc/rofi-theme.5 +++ b/doc/rofi-theme.5 @@ -1598,7 +1598,22 @@ hitting accept will activate the first entry. .RE .PP -Each element is a \fB\fCbox\fR called \fB\fCelement\fR\&. Each \fB\fCelement\fR can contain an \fB\fCelement-icon\fR and \fB\fCelement-text\fR\&. +The listview widget is special container widget. +It has the following children: + * 0 or more \fB\fCelement\fR widgets of the type box. + * An optional \fB\fCscrollbar\fR widget. This can be enabled using + the scrollbar property. + +.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: + * \fB\fCelement-icon\fR: An icon widget showing the icon associated to the entry. + * \fB\fCelement-text\fR: A textbox widget showing the text associated to the entry. + * \fB\fCelement-index\fR: A textbox widget that shows the shortcut keybinding number. + +.PP +A child added with another name is seen as a \fB\fCbox\fR, this can be used to tweak +how an entry looks to expand to available space. .SS listview text highlight .PP diff --git a/doc/rofi-theme.5.markdown b/doc/rofi-theme.5.markdown index 11e52dd3..44f4f8d3 100644 --- a/doc/rofi-theme.5.markdown +++ b/doc/rofi-theme.5.markdown @@ -988,7 +988,20 @@ 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. -Each element is a `box` called `element`. Each `element` can contain an `element-icon` and `element-text`. +The listview widget is special container widget. +It has the following children: + * 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: + * `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 to expand to available space. #### listview text highlight |