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