0544cfd4fa199772e9d056c0a790184b40775a54
[manmower/openbox.git] / data / rc.xsd
1 <?xml version="1.0" encoding="UTF-8"?> <!-- -*- nxml -*- -->
2
3 <!-- XML Schema for the Openbox window manager 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:complexType>
40     <xsd:complexType name="focus">
41         <xsd:annotation>
42             <xsd:documentation>defines aspects of window focus</xsd:documentation>
43         </xsd:annotation>
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"/>
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:element name="center" type="ob:bool"/>
57         <xsd:element name="active" type="ob:bool"/>
58     </xsd:complexType>
59     <xsd:complexType name="margins">
60         <xsd:annotation>
61             <xsd:documentation>defines desktop margins</xsd:documentation>
62         </xsd:annotation>
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"/>
67     </xsd:complexType>              
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"/>
74     </xsd:complexType>
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"/>
81     </xsd:complexType>
82     <xsd:complexType name="desktops">
83         <xsd:annotation>
84             <xsd:documentation>defines the number and names of desktops</xsd:documentation>
85         </xsd:annotation>
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">
89             <xsd:complexType>
90                 <xsd:element maxOccurs="unbounded" name="name" type="xsd:string"/>
91             </xsd:complexType>
92         </xsd:element>
93         <xsd:element minOccurs="0" name="popupTime" type="xsd:integer"/>
94     </xsd:complexType>
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"/>
100     </xsd:complexType>
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"/>
104     </xsd:complexType>
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"/>
116     </xsd:complexType>
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"/>
137     </xsd:complexType>
138     <xsd:complexType name="keybind">
139         <xsd:choice>
140             <xsd:element maxOccurs="unbounded" name="action" type="ob:action"/>
141             <xsd:element maxOccurs="unbounded" name="keybind" type="ob:keybind"/>
142         </xsd:choice>
143         <xsd:attribute name="chroot" type="ob:bool"/>
144         <xsd:attribute name="key" type="ob:keyname" use="required"/>
145     </xsd:complexType>
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"/>
149     </xsd:complexType>
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"/>
154     </xsd:complexType>
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"/>
158     </xsd:complexType>
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"/>
164     </xsd:complexType>
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:complexType>
172     <xsd:complexType name="window_position">
173         <xsd:element name="x" type="ob:center_or_int"/>
174         <xsd:element name="y" type="ob:center_or_int"/>
175         <xsd:element name="monitor" type="ob:mouse_or_int"/>    
176         <xsd:element minOccurs="0" name="head" type="xsd:string"/>
177     </xsd:complexType>
178     <xsd:complexType name="application">
179         <xsd:element minOccurs="0" name="decor" type="xsd:bool"/>
180         <xsd:element minOccurs="0" name="shade" type="ob:bool"/>
181         <xsd:element minOccurs="0" name="position" type="ob:window_position"/>
182         <xsd:element minOccurs="0" name="focus" type="xsd:string"/>
183         <xsd:element minOccurs="0" name="desktop" type="xsd:integer"/>
184         <xsd:element minOccurs="0" name="layer" type="ob:layer"/>
185         <xsd:element minOccurs="0" name="iconic" type="ob:bool"/>
186         <xsd:element minOccurs="0" name="skip_pager" type="ob:bool"/>
187         <xsd:element minOccurs="0" name="skip_taskbar" type="ob:bool"/>
188         <xsd:element minOccurs="0" name="fullscreen" type="ob:bool"/>
189         <xsd:element minOccurs="0" name="maximized" type="ob:maximization"/>
190         <!-- at least one of these must be present -->
191         <xsd:attribute name="name" type="xsd:string"/>
192         <xsd:attribute name="class" type="xsd:string"/>
193         <xsd:attribute name="role" type="xsd:string"/>
194     </xsd:complexType>
195     <xsd:complexType name="applications">
196         <xsd:element minOccurs="0" maxOccurs="unbounded" name="application" type="ob:application"/>
197     </xsd:complexType>
198     <!--
199          simple types / restrictions
200       -->
201     <xsd:simpleType name="actionname">
202         <xsd:restriction base="xsd:string">
203             <xsd:enumeration value="AddDesktop"/>
204             <xsd:enumeration value="BreakChroot"/>
205             <xsd:enumeration value="Close"/>
206             <xsd:enumeration value="Debug"/>
207             <xsd:enumeration value="Decorate"/>
208             <xsd:enumeration value="DirectionalCycleWindows"/>
209             <xsd:enumeration value="DirectionalTargetWindow"/>
210             <xsd:enumeration value="Execute"/>
211             <xsd:enumeration value="Exit"/>
212             <xsd:enumeration value="Focus"/>
213             <xsd:enumeration value="FocusToBottom"/>
214             <xsd:enumeration value="GoToDesktop"/>
215             <xsd:enumeration value="GrowToEdge"/>
216             <xsd:enumeration value="Iconify"/>
217             <xsd:enumeration value="If"/>
218             <xsd:enumeration value="Kill"/>
219             <xsd:enumeration value="Lower"/>
220             <xsd:enumeration value="Maximize"/>
221             <xsd:enumeration value="Move"/>
222             <xsd:enumeration value="MoveRelative"/>
223             <xsd:enumeration value="MoveResizeTo"/>
224             <xsd:enumeration value="MoveToEdge"/>
225             <xsd:enumeration value="NextWindow"/>
226             <xsd:enumeration value="PreviousWindow"/>
227             <xsd:enumeration value="Raise"/>
228             <xsd:enumeration value="RaiseLower"/>
229             <xsd:enumeration value="Reconfigure"/>
230             <xsd:enumeration value="RemoveDesktop"/>
231             <xsd:enumeration value="Resize"/>
232             <xsd:enumeration value="ResizeRelative"/>
233             <xsd:enumeration value="Restart"/>
234             <xsd:enumeration value="SendToDesktop"/>
235             <xsd:enumeration value="SendToLayer"/>
236             <xsd:enumeration value="Shade"/>
237             <xsd:enumeration value="ShowMenu"/>
238             <xsd:enumeration value="ToggleAlwaysOnBottom"/>
239             <xsd:enumeration value="ToggleAlwaysOnTop"/>
240             <xsd:enumeration value="ToggleDecorations"/>
241             <xsd:enumeration value="ToggleDockAutoHide"/>
242             <xsd:enumeration value="ToggleFullscreen"/>
243             <xsd:enumeration value="ToggleMaximize"/>
244             <xsd:enumeration value="ToggleOmnipresent"/>
245             <xsd:enumeration value="ToggleShade"/>
246             <xsd:enumeration value="ToggleShowDesktop"/>
247             <xsd:enumeration value="Undecorate"/>
248             <xsd:enumeration value="Unfocus"/>
249             <xsd:enumeration value="Unmaximize"/>
250             <xsd:enumeration value="Unshade"/>
251         </xsd:restriction>
252     </xsd:simpleType>
253     <xsd:simpleType name="bool">
254         <!-- this is copied to maximization.  Keep that in sync. -->
255         <xsd:restriction base="xsd:string">
256             <xsd:enumeration value="yes"/>
257             <xsd:enumeration value="no"/>
258             <xsd:enumeration value="true"/>
259             <xsd:enumeration value="false"/>
260             <xsd:enumeration value="on"/>
261             <xsd:enumeration value="off"/>
262         </xsd:restriction>
263     </xsd:simpleType>
264     <xsd:simpleType name="fontplace">
265         <xsd:restriction base="xsd:string">
266             <xsd:enumeration value="ActiveWindow"/>
267             <xsd:enumeration value="InactiveWindow"/>
268             <xsd:enumeration value="MenuHeader"/>
269             <xsd:enumeration value="MenuItem"/>
270             <xsd:enumeration value="OnScreenDisplay"/>
271         </xsd:restriction>
272     </xsd:simpleType>
273     <xsd:simpleType name="fontweight">
274         <xsd:restriction base="xsd:string">
275             <xsd:enumeration value="normal"/>
276             <xsd:enumeration value="bold"/>
277         </xsd:restriction>
278     </xsd:simpleType>
279     <xsd:simpleType name="fontslant">
280         <xsd:restriction base="xsd:string">
281             <xsd:enumeration value="normal"/>
282             <xsd:enumeration value="italic"/>
283             <xsd:enumeration value="opaque"/>
284         </xsd:restriction>
285     </xsd:simpleType>
286     <xsd:simpleType name="button">
287         <xsd:restriction base="xsd:string">
288             <!-- FIXME what??? -->
289             <xsd:enumeration value="Left"/>
290             <xsd:enumeration value="Middle"/>
291             <xsd:enumeration value="Right"/>
292             <xsd:enumeration value="Up"/>
293             <xsd:enumeration value="Down"/>
294             <xsd:enumeration value="A-Left"/>
295             <xsd:enumeration value="A-Middle"/>
296             <xsd:enumeration value="A-Right"/>
297             <xsd:enumeration value="A-Up"/>
298             <xsd:enumeration value="A-Down"/>
299             <xsd:enumeration value="C-A-Left"/>
300             <xsd:enumeration value="C-A-Middle"/>
301             <xsd:enumeration value="C-A-Right"/>
302             <xsd:enumeration value="C-A-Up"/>
303             <xsd:enumeration value="C-A-Down"/>
304         </xsd:restriction>
305     </xsd:simpleType>
306     <xsd:simpleType name="center_or_int">
307         <xsd:restriction base="xsd:string">
308             <!-- ob: atoi($_) unless $_ eq 'center'; -->
309             <!-- I think the regexp DTRT WRT atoi. -->
310             <xsd:pattern value="center|0|[1-9][0-9]*"/>
311         </xsd:restriction>
312     </xsd:simpleType>
313     <xsd:simpleType name="mouse_or_int">
314         <xsd:restriction base="xsd:string">
315             <!-- ob: atoi($_) unless $_ eq 'center'; -->
316             <!-- I think the regexp DTRT WRT atoi. -->
317             <xsd:pattern value="mouse|0|[1-9][0-9]*"/>
318         </xsd:restriction>
319     </xsd:simpleType>
320     <xsd:simpleType name="contextname">
321         <xsd:restriction base="xsd:string">
322             <xsd:enumeration value="Desktop"/>
323             <xsd:enumeration value="Root"/>
324             <xsd:enumeration value="Client"/>
325             <xsd:enumeration value="Titlebar"/>
326             <xsd:enumeration value="Frame"/>
327             <xsd:enumeration value="TLCorner"/>
328             <xsd:enumeration value="TRCorner"/>
329             <xsd:enumeration value="BLCorner"/>
330             <xsd:enumeration value="BRCorner"/>
331             <xsd:enumeration value="Top"/>
332             <xsd:enumeration value="Left"/>
333             <xsd:enumeration value="Right"/>
334             <xsd:enumeration value="Bottom"/>
335             <xsd:enumeration value="Maximize"/>
336             <xsd:enumeration value="AllDesktops"/>
337             <xsd:enumeration value="Shade"/>
338             <xsd:enumeration value="Iconify"/>
339             <xsd:enumeration value="Icon"/>
340             <xsd:enumeration value="Close"/>
341             <xsd:enumeration value="MoveResize"/>
342         </xsd:restriction>
343     </xsd:simpleType>
344     <xsd:simpleType name="direction">
345         <xsd:restriction base="xsd:string">
346             <xsd:enumeration value="Horizontal"/>
347             <xsd:enumeration value="Vertical"/>
348         </xsd:restriction>
349     </xsd:simpleType>
350     <xsd:simpleType name="dock_position">
351         <xsd:restriction base="xsd:string">
352             <xsd:enumeration value="TopLeft"/>
353             <xsd:enumeration value="Top"/>
354             <xsd:enumeration value="TopRight"/>
355             <xsd:enumeration value="Right"/>
356             <xsd:enumeration value="BottomRight"/>
357             <xsd:enumeration value="Bottom"/>
358             <xsd:enumeration value="BottomLeft"/>
359             <xsd:enumeration value="Left"/>
360             <xsd:enumeration value="Floating"/>
361         </xsd:restriction>
362     </xsd:simpleType>
363     <xsd:simpleType name="keyname">
364         <xsd:restriction base="xsd:string">
365             <!-- FIXME: M, Mod2, Mod5 in addition to S, A, C -->
366             <!-- how do we do all substrings and permutations? -->
367             <xsd:pattern value="(A-)?(S-)?(A-)?(C-)?(A-)?(S-)?(A-)?[a-zA-Z0-9]*"/>
368         </xsd:restriction>
369     </xsd:simpleType>
370     <xsd:simpleType name="layer">
371         <xsd:restriction base="xsd:string">
372             <xsd:enumeration value="Above"/>
373             <xsd:enumeration value="Normal"/>
374             <xsd:enumeration value="Below"/>
375         </xsd:restriction>
376     </xsd:simpleType>
377     <xsd:simpleType name="maximization">
378         <xsd:restriction base="xsd:string">
379             <xsd:enumeration value="Horizontal"/>
380             <xsd:enumeration value="Vertical"/>
381             <!-- this is a copy of ob:bool.  Keep it in sync. -->
382             <xsd:enumeration value="yes"/>
383             <xsd:enumeration value="no"/>
384             <xsd:enumeration value="true"/>
385             <xsd:enumeration value="false"/>
386             <xsd:enumeration value="on"/>
387             <xsd:enumeration value="off"/>
388         </xsd:restriction>
389     </xsd:simpleType>
390     <xsd:simpleType name="mouseaction">
391         <xsd:restriction base="xsd:string">
392             <xsd:enumeration value="Click"/>
393             <xsd:enumeration value="DoubleClick"/>
394             <xsd:enumeration value="Drag"/>
395             <xsd:enumeration value="Press"/>
396             <xsd:enumeration value="Release"/>
397         </xsd:restriction>
398     </xsd:simpleType>
399     <xsd:simpleType name="placementpolicy">
400         <xsd:restriction base="xsd:string">
401             <xsd:enumeration value="Smart"/>
402             <xsd:enumeration value="UnderMouse"/>
403         </xsd:restriction>
404     </xsd:simpleType>
405     <xsd:simpleType name="popupposition">
406         <xsd:restriction base="xsd:string">
407             <xsd:enumeration value="Top"/>
408             <xsd:enumeration value="Center"/>
409         </xsd:restriction>
410     </xsd:simpleType>
411     <xsd:simpleType name="popupshow">
412         <xsd:restriction base="xsd:string">
413             <xsd:enumeration value="Always"/>
414             <xsd:enumeration value="Never"/>
415             <xsd:enumeration value="Nonpixel"/>
416         </xsd:restriction>
417     </xsd:simpleType>
418 </xsd:schema>