1 <?xml version="1.0" encoding="UTF-8"?> <!-- -*- nxml -*- -->
3 <!-- XML Schema for the Openbox window manager configuration file -->
5 <xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
6 targetNamespace="http://openbox.org/3.4/rc"
7 xmlns:ob="http://openbox.org/3.4/rc"
8 elementFormDefault="qualified">
12 <xsd:element name="openbox_config">
14 <xsd:documentation>all these elements are expected in a openbox config file</xsd:documentation>
17 <xsd:element name="resistance" type="ob:resistance"/>
18 <xsd:element name="focus" type="ob:focus"/>
19 <xsd:element name="placement" type="ob:placement"/>
20 <xsd:element name="theme" type="ob:theme"/>
21 <xsd:element name="desktops" type="ob:desktops"/>
22 <xsd:element name="resize" type="ob:resize"/>
23 <xsd:element name="dock" type="ob:dock"/>
24 <xsd:element name="keyboard" type="ob:keyboard"/>
25 <xsd:element name="mouse" type="ob:mouse"/>
26 <xsd:element name="menu" type="ob:menu"/>
27 <xsd:element name="applications" type="ob:applications"/>
33 <xsd:complexType name="resistance">
35 <xsd:documentation>defines behaviour of windows when close to each other or the screen edge</xsd:documentation>
37 <xsd:element minOccurs="0" name="strength" type="xsd:integer"/>
38 <xsd:element minOccurs="0" name="screen_edge_strength" type="xsd:integer"/>
40 <xsd:complexType name="focus">
42 <xsd:documentation>defines aspects of window focus</xsd:documentation>
44 <xsd:element minOccurs="0" name="focusNew" type="ob:bool"/>
45 <xsd:element minOccurs="0" name="focusLast" type="ob:bool"/>
46 <xsd:element minOccurs="0" name="followMouse" type="ob:bool"/>
47 <xsd:element minOccurs="0" name="underMouse" type="ob:bool"/>
48 <xsd:element minOccurs="0" name="focusDelay" type="xsd:integer"/>
49 <xsd:element minOccurs="0" name="raiseOnFocus" type="ob:bool"/>
51 <xsd:complexType name="placement">
53 <xsd:documentation>defines how new windows are placed</xsd:documentation>
55 <xsd:element name="policy" type="ob:placementpolicy"/>
56 <xsd:element name="center" type="ob:bool"/>
57 <xsd:element name="monitor" type="ob:placementmonitor"/>
59 <xsd:complexType name="margins">
61 <xsd:documentation>defines desktop margins</xsd:documentation>
63 <xsd:element minOccurs="0" name="top" type="xsd:integer"/>
64 <xsd:element minOccurs="0" name="left" type="xsd:integer"/>
65 <xsd:element minOccurs="0" name="right" type="xsd:integer"/>
66 <xsd:element minOccurs="0" name="bottom" type="xsd:integer"/>
68 <xsd:complexType name="theme">
69 <xsd:element minOccurs="0" name="name" type="xsd:string"/>
70 <xsd:element minOccurs="0" name="titleLayout" type="xsd:string"/>
71 <xsd:element minOccurs="0" name="keepBorder" type="ob:bool"/>
72 <xsd:element minOccurs="0" name="animateIconify" type="ob:bool"/>
73 <xsd:element minOccurs="0" name="font" type="ob:font"/>
75 <xsd:complexType name="font">
76 <xsd:element minOccurs="0" name="name" type="xsd:string"/>
77 <xsd:element minOccurs="0" name="size" type="xsd:integer"/>
78 <xsd:element minOccurs="0" name="weight" type="ob:fontweight"/>
79 <xsd:element minOccurs="0" name="slant" type="ob:fontslant"/>
80 <xsd:attribute name="place" type="ob:fontplace" use="required"/>
82 <xsd:complexType name="desktops">
84 <xsd:documentation>defines the number and names of desktops</xsd:documentation>
86 <xsd:element minOccurs="0" name="number" type="xsd:integer"/>
87 <xsd:element minOccurs="0" name="firstdesk" type="xsd:integer"/>
88 <xsd:element minOccurs="0" name="names">
90 <xsd:element maxOccurs="unbounded" name="name" type="xsd:string"/>
93 <xsd:element minOccurs="0" name="popupTime" type="xsd:integer"/>
95 <xsd:complexType name="resize">
96 <xsd:element minOccurs="0" name="drawContents" type="ob:bool"/>
97 <xsd:element minOccurs="0" name="popupShow" type="ob:popupshow"/>
98 <xsd:element minOccurs="0" name="popupPosition" type="ob:popupposition"/>
99 <xsd:element minOccurs="0" name="popupPosition" type="ob:popupfixedposition"/>
101 <xsd:complexType name="popupfixedposition">
102 <xsd:element minOccurs="0" name="x" type="ob:center_or_int"/>
103 <xsd:element minOccurs="0" name="y" type="ob:center_or_int"/>
105 <xsd:complexType name="dock">
106 <xsd:element minOccurs="0" name="position" type="ob:dock_position"/>
107 <xsd:element minOccurs="0" name="floatingX" type="xsd:integer"/>
108 <xsd:element minOccurs="0" name="floatingY" type="xsd:integer"/>
109 <xsd:element minOccurs="0" name="noStrut" type="ob:bool"/>
110 <xsd:element minOccurs="0" name="stacking" type="ob:layer"/>
111 <xsd:element minOccurs="0" name="direction" type="ob:direction"/>
112 <xsd:element minOccurs="0" name="autoHide" type="ob:bool"/>
113 <xsd:element minOccurs="0" name="hideDelay" type="xsd:integer"/>
114 <xsd:element minOccurs="0" name="showDelay" type="xsd:integer"/>
115 <xsd:element minOccurs="0" name="moveButton" type="ob:button"/>
117 <xsd:complexType name="action">
118 <xsd:element minOccurs="0" name="execute" type="xsd:string"/>
119 <xsd:element minOccurs="0" name="command" type="xsd:string"/>
120 <xsd:element minOccurs="0" name="menu" type="xsd:string"/>
121 <xsd:element minOccurs="0" name="delta" type="xsd:integer"/>
122 <xsd:element minOccurs="0" name="x" type="xsd:integer"/>
123 <xsd:element minOccurs="0" name="y" type="xsd:integer"/>
124 <xsd:element minOccurs="0" name="left" type="xsd:integer"/>
125 <xsd:element minOccurs="0" name="right" type="xsd:integer"/>
126 <xsd:element minOccurs="0" name="up" type="xsd:integer"/>
127 <xsd:element minOccurs="0" name="down" type="xsd:integer"/>
128 <xsd:element minOccurs="0" name="desktop" type="xsd:integer"/>
129 <xsd:element minOccurs="0" name="wrap" type="ob:bool"/>
130 <xsd:element minOccurs="0" name="follow" type="ob:bool"/>
131 <xsd:element minOccurs="0" name="dialog" type="ob:bool"/>
132 <xsd:element minOccurs="0" name="panels" type="ob:bool"/>
133 <xsd:element minOccurs="0" name="here" type="ob:bool"/>
134 <xsd:element minOccurs="0" name="linear" type="ob:bool"/>
135 <xsd:element minOccurs="0" name="group" type="ob:bool"/>
136 <xsd:attribute name="name" type="ob:actionname" use="required"/>
138 <xsd:complexType name="keybind">
140 <xsd:element maxOccurs="unbounded" name="action" type="ob:action"/>
141 <xsd:element maxOccurs="unbounded" name="keybind" type="ob:keybind"/>
143 <xsd:attribute name="chroot" type="ob:bool"/>
144 <xsd:attribute name="key" type="ob:keyname" use="required"/>
146 <xsd:complexType name="keyboard">
147 <xsd:element minOccurs="0" name="chainQuitKey" type="ob:keyname"/>
148 <xsd:element maxOccurs="unbounded" name="keybind" type="ob:keybind"/>
150 <xsd:complexType name="mousebind">
151 <xsd:element maxOccurs="unbounded" name="action" type="ob:action"/>
152 <xsd:attribute name="action" type="ob:mouseaction" use="required"/>
153 <xsd:attribute name="button" type="ob:button" use="required"/>
155 <xsd:complexType name="context">
156 <xsd:element maxOccurs="unbounded" name="mousebind" type="ob:mousebind"/>
157 <xsd:attribute name="name" type="ob:contextname" use="required"/>
159 <xsd:complexType name="mouse">
160 <xsd:element minOccurs="0" name="dragThreshold" type="xsd:integer"/>
161 <xsd:element minOccurs="0" name="doubleClickTime" type="xsd:integer"/>
162 <xsd:element minOccurs="0" name="screenEdgeWarpTime" type="xsd:integer"/>
163 <xsd:element maxOccurs="unbounded" name="context" type="ob:context"/>
165 <xsd:complexType name="menu">
166 <xsd:element maxOccurs="unbounded" name="file" type="xsd:string"/>
167 <xsd:element minOccurs="0" name="hideDelay" type="xsd:integer"/>
168 <xsd:element minOccurs="0" name="middle" type="ob:bool"/>
169 <xsd:element minOccurs="0" name="submenuShowDelay" type="xsd:integer"/>
170 <xsd:element minOccurs="0" name="applicationIcons" type="ob:bool"/>
171 <xsd:element minOccurs="0" name="manageDesktops" type="ob:bool"/>
173 <xsd:complexType name="window_position">
174 <xsd:element name="x" type="ob:center_or_int"/>
175 <xsd:element name="y" type="ob:center_or_int"/>
176 <xsd:element name="monitor" type="ob:mouse_or_int"/>
177 <xsd:element minOccurs="0" name="head" type="xsd:string"/>
179 <xsd:complexType name="application">
180 <xsd:element minOccurs="0" name="decor" type="xsd:bool"/>
181 <xsd:element minOccurs="0" name="shade" type="ob:bool"/>
182 <xsd:element minOccurs="0" name="position" type="ob:window_position"/>
183 <xsd:element minOccurs="0" name="focus" type="xsd:string"/>
184 <xsd:element minOccurs="0" name="desktop" type="xsd:integer"/>
185 <xsd:element minOccurs="0" name="layer" type="ob:layer"/>
186 <xsd:element minOccurs="0" name="iconic" type="ob:bool"/>
187 <xsd:element minOccurs="0" name="skip_pager" type="ob:bool"/>
188 <xsd:element minOccurs="0" name="skip_taskbar" type="ob:bool"/>
189 <xsd:element minOccurs="0" name="fullscreen" type="ob:bool"/>
190 <xsd:element minOccurs="0" name="maximized" type="ob:maximization"/>
191 <!-- at least one of these must be present -->
192 <xsd:attribute name="name" type="xsd:string"/>
193 <xsd:attribute name="class" type="xsd:string"/>
194 <xsd:attribute name="role" type="xsd:string"/>
196 <xsd:complexType name="applications">
197 <xsd:element minOccurs="0" maxOccurs="unbounded" name="application" type="ob:application"/>
200 simple types / restrictions
202 <xsd:simpleType name="actionname">
203 <xsd:restriction base="xsd:string">
204 <xsd:enumeration value="Activate"/>
205 <xsd:enumeration value="BreakChroot"/>
206 <xsd:enumeration value="Close"/>
207 <xsd:enumeration value="Desktop"/>
208 <xsd:enumeration value="DesktopDown"/>
209 <xsd:enumeration value="DesktopLast"/>
210 <xsd:enumeration value="DesktopLeft"/>
211 <xsd:enumeration value="DesktopNext"/>
212 <xsd:enumeration value="DesktopPrevious"/>
213 <xsd:enumeration value="DesktopRight"/>
214 <xsd:enumeration value="DesktopUp"/>
215 <xsd:enumeration value="DirectionalFocusEast"/>
216 <xsd:enumeration value="DirectionalFocusNorth"/>
217 <xsd:enumeration value="DirectionalFocusNortheast"/>
218 <xsd:enumeration value="DirectionalFocusNorthwest"/>
219 <xsd:enumeration value="DirectionalFocusSouth"/>
220 <xsd:enumeration value="DirectionalFocusSoutheast"/>
221 <xsd:enumeration value="DirectionalFocusSouthwest"/>
222 <xsd:enumeration value="DirectionalFocusWest"/>
223 <xsd:enumeration value="Execute"/>
224 <xsd:enumeration value="Exit"/>
225 <xsd:enumeration value="Focus"/>
226 <xsd:enumeration value="FocusToBottom"/>
227 <xsd:enumeration value="GrowToEdgeEast"/>
228 <xsd:enumeration value="GrowToEdgeNorth"/>
229 <xsd:enumeration value="GrowToEdgeSouth"/>
230 <xsd:enumeration value="GrowToEdgeWest"/>
231 <xsd:enumeration value="Iconify"/>
232 <xsd:enumeration value="Kill"/>
233 <xsd:enumeration value="Lower"/>
234 <xsd:enumeration value="MaximizeFull"/>
235 <xsd:enumeration value="MaximizeHorz"/>
236 <xsd:enumeration value="MaximizeVert"/>
237 <xsd:enumeration value="Move"/>
238 <xsd:enumeration value="MoveRelative"/>
239 <xsd:enumeration value="MoveRelativeHorz"/>
240 <xsd:enumeration value="MoveRelativeVert"/>
241 <xsd:enumeration value="MoveToCenter"/>
242 <xsd:enumeration value="MoveFromEdgeEast"/>
243 <xsd:enumeration value="MoveFromEdgeNorth"/>
244 <xsd:enumeration value="MoveFromEdgeSouth"/>
245 <xsd:enumeration value="MoveFromEdgeWest"/>
246 <xsd:enumeration value="MoveToEdgeEast"/>
247 <xsd:enumeration value="MoveToEdgeNorth"/>
248 <xsd:enumeration value="MoveToEdgeSouth"/>
249 <xsd:enumeration value="MoveToEdgeWest"/>
250 <xsd:enumeration value="NextWindow"/>
251 <xsd:enumeration value="PreviousWindow"/>
252 <xsd:enumeration value="Raise"/>
253 <xsd:enumeration value="RaiseLower"/>
254 <xsd:enumeration value="Reconfigure"/>
255 <xsd:enumeration value="Resize"/>
256 <xsd:enumeration value="ResizeRelative"/>
257 <xsd:enumeration value="ResizeRelativeHorz"/>
258 <xsd:enumeration value="ResizeRelativeVert"/>
259 <xsd:enumeration value="Restart"/>
260 <xsd:enumeration value="SendToBottomLayer"/>
261 <xsd:enumeration value="SendToDesktop"/>
262 <xsd:enumeration value="SendToDesktopDown"/>
263 <xsd:enumeration value="SendToDesktopLeft"/>
264 <xsd:enumeration value="SendToDesktopNext"/>
265 <xsd:enumeration value="SendToDesktopPrevious"/>
266 <xsd:enumeration value="SendToDesktopRight"/>
267 <xsd:enumeration value="SendToDesktopUp"/>
268 <xsd:enumeration value="SendToNormalLayer"/>
269 <xsd:enumeration value="SendToTopLayer"/>
270 <xsd:enumeration value="Shade"/>
271 <xsd:enumeration value="ShadeLower"/>
272 <xsd:enumeration value="ShowDesktop"/>
273 <xsd:enumeration value="ShowMenu"/>
274 <xsd:enumeration value="ToggleAlwaysOnBottom"/>
275 <xsd:enumeration value="ToggleAlwaysOnTop"/>
276 <xsd:enumeration value="ToggleDecorations"/>
277 <xsd:enumeration value="ToggleDockAutoHide"/>
278 <xsd:enumeration value="ToggleFullscreen"/>
279 <xsd:enumeration value="ToggleMaximizeFull"/>
280 <xsd:enumeration value="ToggleMaximizeHorz"/>
281 <xsd:enumeration value="ToggleMaximizeVert"/>
282 <xsd:enumeration value="ToggleOmnipresent"/>
283 <xsd:enumeration value="ToggleShade"/>
284 <xsd:enumeration value="ToggleShowDesktop"/>
285 <xsd:enumeration value="Unfocus"/>
286 <xsd:enumeration value="UnmaximizeFull"/>
287 <xsd:enumeration value="UnmaximizeHorz"/>
288 <xsd:enumeration value="UnmaximizeVert"/>
289 <xsd:enumeration value="Unshade"/>
290 <xsd:enumeration value="UnshadeRaise"/>
291 <xsd:enumeration value="UnShowDesktop"/>
294 <xsd:simpleType name="bool">
295 <!-- this is copied to maximization. Keep that in sync. -->
296 <xsd:restriction base="xsd:string">
297 <xsd:enumeration value="yes"/>
298 <xsd:enumeration value="no"/>
299 <xsd:enumeration value="true"/>
300 <xsd:enumeration value="false"/>
301 <xsd:enumeration value="on"/>
302 <xsd:enumeration value="off"/>
305 <xsd:simpleType name="fontplace">
306 <xsd:restriction base="xsd:string">
307 <xsd:enumeration value="ActiveWindow"/>
308 <xsd:enumeration value="InactiveWindow"/>
309 <xsd:enumeration value="MenuHeader"/>
310 <xsd:enumeration value="MenuItem"/>
311 <xsd:enumeration value="OnScreenDisplay"/>
314 <xsd:simpleType name="fontweight">
315 <xsd:restriction base="xsd:string">
316 <xsd:enumeration value="normal"/>
317 <xsd:enumeration value="bold"/>
320 <xsd:simpleType name="fontslant">
321 <xsd:restriction base="xsd:string">
322 <xsd:enumeration value="normal"/>
323 <xsd:enumeration value="italic"/>
324 <xsd:enumeration value="opaque"/>
327 <xsd:simpleType name="button">
328 <xsd:restriction base="xsd:string">
329 <!-- FIXME what??? -->
330 <xsd:enumeration value="Left"/>
331 <xsd:enumeration value="Middle"/>
332 <xsd:enumeration value="Right"/>
333 <xsd:enumeration value="Up"/>
334 <xsd:enumeration value="Down"/>
335 <xsd:enumeration value="A-Left"/>
336 <xsd:enumeration value="A-Middle"/>
337 <xsd:enumeration value="A-Right"/>
338 <xsd:enumeration value="A-Up"/>
339 <xsd:enumeration value="A-Down"/>
340 <xsd:enumeration value="C-A-Left"/>
341 <xsd:enumeration value="C-A-Middle"/>
342 <xsd:enumeration value="C-A-Right"/>
343 <xsd:enumeration value="C-A-Up"/>
344 <xsd:enumeration value="C-A-Down"/>
347 <xsd:simpleType name="center_or_int">
348 <xsd:restriction base="xsd:string">
349 <!-- ob: atoi($_) unless $_ eq 'center'; -->
350 <!-- I think the regexp DTRT WRT atoi. -->
351 <xsd:pattern value="center|0|[1-9][0-9]*"/>
354 <xsd:simpleType name="mouse_or_int">
355 <xsd:restriction base="xsd:string">
356 <!-- ob: atoi($_) unless $_ eq 'center'; -->
357 <!-- I think the regexp DTRT WRT atoi. -->
358 <xsd:pattern value="mouse|0|[1-9][0-9]*"/>
361 <xsd:simpleType name="contextname">
362 <xsd:restriction base="xsd:string">
363 <xsd:enumeration value="Desktop"/>
364 <xsd:enumeration value="Root"/>
365 <xsd:enumeration value="Client"/>
366 <xsd:enumeration value="Titlebar"/>
367 <xsd:enumeration value="Frame"/>
368 <xsd:enumeration value="TLCorner"/>
369 <xsd:enumeration value="TRCorner"/>
370 <xsd:enumeration value="BLCorner"/>
371 <xsd:enumeration value="BRCorner"/>
372 <xsd:enumeration value="Top"/>
373 <xsd:enumeration value="Left"/>
374 <xsd:enumeration value="Right"/>
375 <xsd:enumeration value="Bottom"/>
376 <xsd:enumeration value="Handle"/>
377 <xsd:enumeration value="Maximize"/>
378 <xsd:enumeration value="AllDesktops"/>
379 <xsd:enumeration value="Shade"/>
380 <xsd:enumeration value="Iconify"/>
381 <xsd:enumeration value="Icon"/>
382 <xsd:enumeration value="Close"/>
383 <xsd:enumeration value="MoveResize"/>
386 <xsd:simpleType name="direction">
387 <xsd:restriction base="xsd:string">
388 <xsd:enumeration value="Horizontal"/>
389 <xsd:enumeration value="Vertical"/>
392 <xsd:simpleType name="dock_position">
393 <xsd:restriction base="xsd:string">
394 <xsd:enumeration value="TopLeft"/>
395 <xsd:enumeration value="Top"/>
396 <xsd:enumeration value="TopRight"/>
397 <xsd:enumeration value="Right"/>
398 <xsd:enumeration value="BottomRight"/>
399 <xsd:enumeration value="Bottom"/>
400 <xsd:enumeration value="BottomLeft"/>
401 <xsd:enumeration value="Left"/>
402 <xsd:enumeration value="Floating"/>
405 <xsd:simpleType name="keyname">
406 <xsd:restriction base="xsd:string">
407 <!-- FIXME: M, Mod2, Mod5 in addition to S, A, C -->
408 <!-- how do we do all substrings and permutations? -->
409 <xsd:pattern value="(A-)?(S-)?(A-)?(C-)?(A-)?(S-)?(A-)?[a-zA-Z0-9]*"/>
412 <xsd:simpleType name="layer">
413 <xsd:restriction base="xsd:string">
414 <xsd:enumeration value="Above"/>
415 <xsd:enumeration value="Normal"/>
416 <xsd:enumeration value="Below"/>
419 <xsd:simpleType name="maximization">
420 <xsd:restriction base="xsd:string">
421 <xsd:enumeration value="Horizontal"/>
422 <xsd:enumeration value="Vertical"/>
423 <!-- this is a copy of ob:bool. Keep it in sync. -->
424 <xsd:enumeration value="yes"/>
425 <xsd:enumeration value="no"/>
426 <xsd:enumeration value="true"/>
427 <xsd:enumeration value="false"/>
428 <xsd:enumeration value="on"/>
429 <xsd:enumeration value="off"/>
432 <xsd:simpleType name="mouseaction">
433 <xsd:restriction base="xsd:string">
434 <xsd:enumeration value="Click"/>
435 <xsd:enumeration value="DoubleClick"/>
436 <xsd:enumeration value="Drag"/>
437 <xsd:enumeration value="Press"/>
438 <xsd:enumeration value="Release"/>
441 <xsd:simpleType name="placementpolicy">
442 <xsd:restriction base="xsd:string">
443 <xsd:enumeration value="Smart"/>
444 <xsd:enumeration value="UnderMouse"/>
447 <xsd:simpleType name="placementmonitor">
448 <xsd:restriction base="xsd:string">
449 <xsd:enumeration value="Any"/>
450 <xsd:enumeration value="Mouse"/>
451 <xsd:enumeration value="Active"/>
454 <xsd:simpleType name="popupposition">
455 <xsd:restriction base="xsd:string">
456 <xsd:enumeration value="Top"/>
457 <xsd:enumeration value="Center"/>
460 <xsd:simpleType name="popupshow">
461 <xsd:restriction base="xsd:string">
462 <xsd:enumeration value="Always"/>
463 <xsd:enumeration value="Never"/>
464 <xsd:enumeration value="Nonpixel"/>