PolytreeDE
/
rofi
mirror of https://github.com/davatorium/rofi.git
1
0
Fork 0
Code Releases Activity

[Doc] Try to clarify the children situation for the listview widget.

This commit is contained in:
Dave Davenport 2023-01-25 22:55:04 +01:00
parent 48e5478ceb
commit 7a1eb91329
2 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/rofi-theme.5
View File

@ -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

15
doc/rofi-theme.5.markdown
View File

@ -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