2016-12-19 07:10:33 +00:00
|
|
|
# Basic Organization
|
2016-12-09 18:49:49 +00:00
|
|
|
|
|
|
|
Each widget has:
|
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
## Name
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
Name: Internal name of the widget.
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
Sub-widgets are {Parent}.{Child}.
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2017-01-05 08:40:10 +00:00
|
|
|
Example: window, window.mainbox.listview, window.mainbox.listview.element
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
Names are prefixed with a `#`
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
List of names in **rofi**:
|
|
|
|
|
2016-12-20 08:17:19 +00:00
|
|
|
* `#window`
|
2017-01-05 08:40:10 +00:00
|
|
|
* `#window.overlay`: The overlay widget.
|
|
|
|
* `#window.mainbox`
|
|
|
|
* `#window.mainbox.box`: The main vertical @box
|
|
|
|
* `#window.mainbox.inputbar`
|
|
|
|
* `#window.mainbox.inputbar.box`: The horizontal @box packing the widgets.
|
|
|
|
* `#window.mainbox.inputbar.case-indicator`: The case/sort indicator @textbox
|
|
|
|
* `#window.mainbox.inputbar.prompt`: The prompt @textbox
|
|
|
|
* `#window.mainbox.inputbar.entry`: The main entry @textbox
|
|
|
|
* `#window.mainbox.listview`
|
|
|
|
* `#window.mainbox.listview.scrollbar`: The listview scrollbar
|
|
|
|
* `#window.mainbox.listview.element`: The entries in the listview
|
|
|
|
* `#window.mainbox.sidebar`
|
|
|
|
* `#window.mainbox.sidebar.box`: The main horizontal @box packing the buttons.
|
|
|
|
* `#window.mainbox.sidebar.button`: The buttons @textbox for each mode.
|
|
|
|
* `#window.mainbox.message`
|
|
|
|
* `#window.mainbox.message.textbox`: The message textbox.
|
2017-01-05 17:33:57 +00:00
|
|
|
* `#window.mainbox.message.box`: The box containing the message.
|
2016-12-13 17:05:40 +00:00
|
|
|
|
|
|
|
## State
|
|
|
|
|
|
|
|
State: State of widget
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-19 07:10:33 +00:00
|
|
|
Optional flag(s) indicating state.
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
These are appended after the name or class of the widget.
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2017-01-05 08:40:10 +00:00
|
|
|
`#window.mainbox.sidebar.button selected.normal { }`
|
2016-12-13 17:10:42 +00:00
|
|
|
|
2017-01-05 08:40:10 +00:00
|
|
|
`#window.mainbox.listview.element selected.urgent { }`
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2017-01-05 08:40:10 +00:00
|
|
|
Currently only the entrybox and scrollbar has states:
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
`{visible modifier}.{state}`
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
Where `visible modifier` can be:
|
|
|
|
* normal: No modification.
|
|
|
|
* selected: The entry is selected/highlighted by user.
|
2016-12-19 07:10:33 +00:00
|
|
|
* alternate: The entry is at an alternating row. (uneven row)
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
Where `state` is:
|
2016-12-13 17:10:42 +00:00
|
|
|
* normal: No modification.
|
|
|
|
* urgent: This entry is marked urgent.
|
|
|
|
* activE: This entry is marked active.
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
These can be mixed.
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
Example:
|
2016-12-13 17:10:42 +00:00
|
|
|
```
|
2017-01-05 08:40:10 +00:00
|
|
|
#name.to.textbox selected.active {
|
2016-12-13 17:05:40 +00:00
|
|
|
background: #003642;
|
|
|
|
foreground: #008ed4;
|
|
|
|
}
|
2016-12-13 17:10:42 +00:00
|
|
|
```
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
Sets all selected textboxes marked active to the given foreground and background color.
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2017-01-05 08:40:10 +00:00
|
|
|
The scrollbar when drawing uses the `handle` state when drawing the small scrollbar handle.
|
|
|
|
Allowing overriding of color.
|
|
|
|
|
2016-12-13 17:05:40 +00:00
|
|
|
# File structure
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2016-12-13 17:10:42 +00:00
|
|
|
The file is structured as follows
|
|
|
|
|
|
|
|
```
|
2016-12-13 17:05:40 +00:00
|
|
|
/* Global properties, that apply as default to all widgets. */
|
|
|
|
{list of properties}
|
2016-12-09 18:49:49 +00:00
|
|
|
|
2017-01-05 08:40:10 +00:00
|
|
|
#{name} {optional state} {
|
2016-12-13 17:05:40 +00:00
|
|
|
{list of properties}
|
|
|
|
}
|
2017-01-05 08:40:10 +00:00
|
|
|
#{name}.{optional state} {
|
2016-12-13 17:05:40 +00:00
|
|
|
{list of properties}
|
2016-12-09 18:49:49 +00:00
|
|
|
}
|
2016-12-13 17:10:42 +00:00
|
|
|
```
|
2016-12-13 17:05:40 +00:00
|
|
|
|
2016-12-16 08:28:13 +00:00
|
|
|
The global properties an freeĺy be mixed between entries.
|
2017-01-05 08:40:10 +00:00
|
|
|
Name and state can be separated by a comman, or joined using a dot.
|
2016-12-13 17:20:09 +00:00
|
|
|
|
|
|
|
Each property is constructed like:
|
|
|
|
```
|
|
|
|
{key} : {value} ;
|
|
|
|
```
|
|
|
|
Key is a simple ascii string.
|
|
|
|
Separated from value by a colon ':';
|
|
|
|
Value supports the following formats:
|
|
|
|
|
|
|
|
* string: `"{string}"`
|
|
|
|
* integer: `[0-9]+`
|
|
|
|
* double: `[0-9]+\.[0-9]`
|
|
|
|
* boolean: `true|false`
|
2016-12-19 07:10:33 +00:00
|
|
|
* color:
|
2016-12-13 17:20:09 +00:00
|
|
|
* `#[0-9a-fA-F]{6}`: hexidecimal rgb color.
|
|
|
|
* `#[0-9a-fA-F]{8}`: hexidecimal argb color.
|
2016-12-19 07:10:33 +00:00
|
|
|
* `argb:[0-0a-fA-F]{8}`: Old **rofi** argb color style.
|
2016-12-13 17:20:09 +00:00
|
|
|
* `rgba\([0-9]{1,3},[0-9]{1,3}, [0-9]{1,3}, {double}\)`: css style rgba color.
|
|
|
|
* `rgb\([0-9]{1,3},[0-9]{1,3}, [0-9]{1,3}\)`: css style rgb color.
|
2017-01-05 08:40:10 +00:00
|
|
|
* distance:
|
|
|
|
* `{size}{unit} {line-style}`
|
|
|
|
* unit can be px,em,%. for px `{size}` is an integer number, for %,em it is a positive real.
|
|
|
|
* {line-style} can be `dash` or `solid` and is optional.
|
|
|
|
* padding: `({distance}){1,4}`
|
2016-12-13 17:21:31 +00:00
|
|
|
|
|
|
|
Each property is closed by a semi-colon `;`;
|
2016-12-19 07:10:33 +00:00
|
|
|
|
|
|
|
The following properties are currently supports:
|
|
|
|
|
2017-01-03 13:25:24 +00:00
|
|
|
* all widgets:
|
|
|
|
* padding: distance
|
2017-01-05 08:40:10 +00:00
|
|
|
* margin: distance
|
|
|
|
* border: distance
|
|
|
|
* background: color
|
|
|
|
* foreground: color
|
|
|
|
* end: boolean
|
2017-01-03 13:25:24 +00:00
|
|
|
|
2016-12-19 07:10:33 +00:00
|
|
|
* window:
|
|
|
|
* font: string
|
2016-12-19 16:49:52 +00:00
|
|
|
* transparency: string
|
|
|
|
- real
|
|
|
|
- background
|
|
|
|
- screenshot
|
|
|
|
- Path to png file
|
2016-12-19 07:10:33 +00:00
|
|
|
|
|
|
|
* scrollbar
|
|
|
|
* foreground: color
|
2017-01-06 14:36:06 +00:00
|
|
|
* handle-width: distance
|
|
|
|
* handle-color: color
|
2017-01-05 08:40:10 +00:00
|
|
|
* foreground: color
|
2016-12-19 07:10:33 +00:00
|
|
|
|
|
|
|
* box
|
2017-01-05 08:40:10 +00:00
|
|
|
* spacing: distance
|
2016-12-19 07:10:33 +00:00
|
|
|
|
2017-01-05 08:40:10 +00:00
|
|
|
* textbox:
|
|
|
|
* background: color
|
|
|
|
* foreground: color
|
2016-12-19 07:10:33 +00:00
|
|
|
|
|
|
|
* listview:
|
|
|
|
* columns: integer
|
|
|
|
* fixed-height: boolean
|
2017-01-03 13:25:24 +00:00
|
|
|
* dynamic: boolean
|
2016-12-19 07:10:33 +00:00
|
|
|
* scrollbar: boolean
|
2017-01-05 08:40:10 +00:00
|
|
|
* scrollbar-width: distance
|
2016-12-19 07:10:33 +00:00
|
|
|
* cycle: boolean
|
2017-01-05 08:40:10 +00:00
|
|
|
* spacing: distance
|
2016-12-20 08:17:19 +00:00
|
|
|
|
|
|
|
|
|
|
|
## Resolving properties
|
|
|
|
|
2017-01-05 08:40:10 +00:00
|
|
|
It tries to find the longest match down the dependency tree.
|
2016-12-20 08:17:19 +00:00
|
|
|
|