1labwc-theme(5) File Formats Manual labwc-theme(5)
2
3
4
6 labwc - theme files
7
9 The theme engine aims to be compatible with openbox and themes will be
10 searched for in the following order:
11
12 • ${XDG_DATA_HOME:-$HOME/.local/share}/themes/<theme-name>/openbox-3/
13 • $HOME/.themes/<theme-name>/openbox-3/
14 • /usr/share/themes/<theme-name>/openbox-3/
15 • /usr/local/share/themes/<theme-name>/openbox-3/
16 • /opt/share/themes/<theme-name>/openbox-3/
17
18
19 Choosing a theme is done by editing the <name> key in the <theme> sec‐
20 tion of the rc.xml configuration file (labwc-config(5)).
21
22 A theme consists of a themerc file and optionally some titlebar icons
23 (referred to as buttons).
24
25 Theme settings specified in themerc can be overridden by creating a
26 'themerc-override' file in the configuration directory, which is nor‐
27 mally $HOME/.config/labwc/ but can be a few other locations as de‐
28 scribed in labwc-config(5).
29
31 color
32 Colors can be specified by either of the following:
33 • #rrggbb (hexadecimal RGB values)
34 • #rrggbb aaa (same but with decimal alpha value)
35
36
37 justification
38 Justification determines the horizontal alignment of text. Valid
39 options are Left, Center and Right.
40
42 border.width
43 Line width (integer) of border border drawn around window frames.
44 Default is 1.
45
46 padding.height
47 Vertical padding size, used for spacing out elements in the window
48 decorations. Default is 3.
49
50 titlebar.height
51 Window title bar height. Default equals the vertical font extents
52 of the title plus 2x padding.height.
53
54 menu.items.padding.x
55 Horizontal padding of menu text entries in pixels. Default is 7.
56
57 menu.items.padding.y
58 Vertical padding of menu text entries in pixels. Default is 4.
59
60 menu.overlap.x
61 Horizontal overlap in pixels between submenus and their parents. A
62 positive value move submenus over the top of their parents, whereas
63 a negative value creates a gap between submenus and their parents.
64 Default is 0.
65
66 menu.overlap.y
67 Vertical offset in pixels between submenus and their parents. Posi‐
68 tive values for downwards and negative for upwards. Default is 0.
69
70 menu.width.min
71 Minimal width for menus. Default is 20. A fixed width can be
72 achieved by setting .min and .max to the same value.
73
74 menu.width.max
75 Maximal width for menus. Default is 200. A fixed width can be
76 achieved by setting .min and .max to the same value.
77
78 window.active.border.color
79 Border color of active window
80
81 window.inactive.border.color
82 Border color of inactive window
83
84 window.active.indicator.toggled-keybind.color
85 Status indicator for the ToggleKeybinds action. Can be set to the
86 same value as set for window.active.border.color to disable the
87 status indicator.
88
89 window.active.title.bg.color
90 Background color for the focused window's titlebar
91
92 window.inactive.title.bg.color
93 Background color for non-focused windows' titlebars
94
95 window.active.label.text.color
96 Text color for the focused window's titlebar
97
98 window.inactive.label.text.color
99 Text color non-focused windows' titlebars
100
101 window.label.text.justify
102 Specifies how window titles are aligned in the titlebar for both
103 focused and unfocused windows. Type justification. Default Left.
104
105 window.active.button.unpressed.image.color
106 Color of the images in titlebar buttons in their default, un‐
107 pressed, state. This element is for the focused window.
108
109 window.inactive.button.unpressed.image.color
110 Color of the images in titlebar buttons in their default, un‐
111 pressed, state. This element is for non-focused windows.
112
113 Note: The button elements (i.e. window.[in]active.button.*) support
114 defining different types of buttons individually by inserting the type
115 ("menu", "iconify", "max" and "close") after the button node. For exam‐
116 ple: window.active.button.iconify.unpressed.image.color This syntax is
117 not documented on the openbox.org wiki, but is supported by openbox and
118 is used by many popular themes. For the sake of brevity, these elements
119 are not listed here, but are supported.
120
121 menu.items.bg.color
122 Background color of inactive menu items
123
124 menu.items.text.color
125 Text color of inactive menu item
126
127 menu.items.active.bg.color
128 Background color of active menu items
129
130 menu.items.active.text.color
131 Text color of active menu item
132
133 menu.separator.width
134 Line thickness of menu separators. Default 1.
135
136 menu.separator.padding.width
137 Space on the left and right side of each separator line. Default 6.
138
139 menu.separator.padding.height
140 Space above and below each separator line. Default 3.
141
142 menu.separator.color
143 Menu separator color. Default #888888.
144
145 osd.bg.color
146 Background color of on-screen-display
147
148 osd.border.color
149 Border color of on-screen-display
150
151 osd.border.width
152 Border width of on-screen-display. Inherits border.width if not
153 set.
154
155 osd.label.text.color
156 Text color of on-screen-display
157
158 osd.window-switcher.width
159 Width of window switcher in pixels. Default is 600.
160
161 osd.window-switcher.padding
162 Padding of window switcher in pixels. This is the space between the
163 window-switcher border and its items. Default is 4.
164
165 osd.window-switcher.item.padding.x
166 Horizontal padding of window switcher entries in pixels. Default is
167 10.
168
169 osd.window-switcher.item.padding.y
170 Vertical padding of window switcher entries in pixels. Default is
171 1.
172
173 osd.window-switcher.item.active.border.width
174 Border width of the selection box in the window switcher in pixels.
175 Default is 2.
176
177 border.color
178 Set all border colors. This is obsolete, but supported for backward
179 compatibility as some themes still contain it.
180
182 The images used for the titlebar icons are referred to as buttons.
183
184 The image formats listed below are supported. They are listed in order
185 of precedence, where the first format in the list is searched for
186 first.
187
188 • png
189 • svg
190 • xbm
191
192
193 By default, buttons are 1-bit xbm (X Bitmaps). These are masks where
194 0=clear and 1=colored. The xbm image files are placed in the same di‐
195 rectory as the themerc file within a particular theme. The following
196 xbm buttons are supported:
197
198 • max.xbm
199 • iconify.xbm
200 • close.xbm
201 • menu.xbm
202
203
204 One advantage of xbm buttons over other formats is that they change
205 color based on the theme. Other formats use the suffices "-active" and
206 "-inactive" to align with the respective titlebar colors. For example:
207 "close-active.png"
208
210 The handle is the window edge decoration at the bottom of the window.
211
213 labwc(1), labwc-config(5), labwc-actions(5)
214
215
216
217 2023-11-26 labwc-theme(5)