add showDelay to dock
[mikachu/openbox.git] / data / rc.xsd
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3      xml Schema for the openbox windowmanager configuration file
4
5      Changes:
6      Son Aug 10 15:49:10 CEST 2003 - pch(a)myzel.net
7          restrictions added, up to current format
8      Don Aug 14 21:10:27 CEST 2003 - pch(a)myzel.net
9          up to current (from action.c,config.c)
10      Don Aug 21 23:07:30 CEST 2003 - pch(a)myzel.net
11          new element - follow
12      Mon Sep  1 00:57:55 CEST 2003 - pch(a)myzel.net
13          up to alpha7
14      Mit Sep  3 12:40:10 CEST 2003 - pch(a)myzel.net
15          up to alpha8, a little documentation
16      Mon Sep  8 11:52:07 CEST 2003 - pch(a)myzel.net
17          up to cvs 1.12
18      Mon Sep 15 14:27:42 CEST 2003 - pch(a)myzel.net
19          up to cvs 1.14
20      Die Sep 16 20:56:37 CEST 2003 - pch(a)myzel.net
21          use a namespace
22      Fri Sep 19 14:36:33 EDT 2003 - xor(a)orodu.net
23          use openbox.org for namespace
24      Mon Sep 22 02:34:53 EDT 2003 - xor(a)orodu.net
25          add the focusLast and raiseOnFocus options
26          fix some capitalization
27      Mon Sep 22 14:08:16 EDT 2003 - xor(a)orodu.net
28          update hideTimeout to hideDelay
29      Thu Apr 22 12:33:11 UTC 2004 - mikachu(a)openbox.org
30          add diffs between 3.1 and 3.2
31      Sun Oct 31 10:08:34 UTC 2004 - mikachu(a)openbox.org
32          we haven't remembered to update this changelog in a while,
33          adding desktopMenuIcons.
34      Thu Nov  4 12:07:08 UTC 2004 - mikachu(a)openbox.org
35          Add fourCorners to resize context.
36      Sat Feb 12 01:57:16 UTC 2005 - mikachu(a)openbox.org
37          Add the group option to raise/lower stuff.
38      Sun Sep 25 14:44:21 UTC 2005 - mikachu(a)openbox.org
39          Add showDelay for the dock
40 -->
41 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
42     targetNamespace="http://openbox.org/"
43     xmlns:ob="http://openbox.org/"
44     elementFormDefault="qualified">
45     <!--
46          root node
47       -->
48     <xs:element name="openbox_config">
49         <xs:annotation>
50             <xs:documentation>all these elements are expected in a openbox config file</xs:documentation>
51         </xs:annotation>
52         <xs:complexType>
53             <xs:sequence>
54                 <xs:element name="resistance" type="ob:resistance"/>
55                 <xs:element name="focus" type="ob:focus"/>
56                 <xs:element name="placement" type="ob:placement"/>
57                 <xs:element name="theme" type="ob:theme"/>
58                 <xs:element name="desktops" type="ob:desktops"/>
59                 <xs:element name="resize" type="ob:resize"/>
60                 <xs:element name="dock" type="ob:dock"/>
61                 <xs:element name="keyboard" type="ob:keyboard"/>
62                 <xs:element name="mouse" type="ob:mouse"/>
63                 <xs:element name="menu" type="ob:menu"/>
64             </xs:sequence>
65         </xs:complexType>
66     </xs:element>
67     <!--
68          complex types
69       -->
70     <xs:complexType name="resistance">
71         <xs:annotation>
72             <xs:documentation>defines behaviour of windows when close to eachother or the screen edge</xs:documentation>
73         </xs:annotation>
74         <xs:sequence>
75             <xs:element name="strength" type="xs:integer"/>
76             <xs:element name="screen_edge_strength" type="xs:integer"/>
77             <xs:element name="edges_hit_layers_below" type="xs:yesorno"/>
78         </xs:sequence>
79     </xs:complexType>
80     <xs:complexType name="focus">
81         <xs:annotation>
82             <xs:documentation>defines aspects of window focus</xs:documentation>
83         </xs:annotation>
84         <xs:sequence>
85             <xs:element name="focusNew" type="ob:yesorno"/>
86             <xs:element name="focusLast" type="ob:yesorno"/>
87             <xs:element name="followMouse" type="ob:yesorno"/>
88             <xs:element name="focusDelay" type="xs:integer"/>
89             <xs:element name="raiseOnFocus" type="ob:yesorno"/>
90         </xs:sequence>
91     </xs:complexType>
92     <xs:complexType name="placement">
93         <xs:annotation>
94             <xs:documentation>defines how new windows are placed</xs:documentation>
95         </xs:annotation>
96         <xs:sequence>
97             <xs:element name="policy" type="ob:placementpolicy"/>
98         </xs:sequence>
99     </xs:complexType>
100     <xs:complexType name="theme">
101         <xs:sequence>
102             <xs:element name="name" type="xs:string"/>
103             <xs:element name="titlelayout" type="xs:string"/>
104             <xs:element name="keepBorder" type="ob:yesorno"/>
105             <xs:element name="hideDisabled" type="ob:yesorno"/>
106         </xs:sequence>
107     </xs:complexType>
108     <xs:complexType name="desktops">
109         <xs:sequence>
110             <xs:element name="number" type="xs:integer"/>
111             <xs:element name="names">
112                 <xs:complexType>
113                     <xs:sequence>
114                         <xs:element maxOccurs="unbounded" name="name" type="xs:string"/>
115                     </xs:sequence>
116                 </xs:complexType>
117             </xs:element>
118             <xs:element name="firstdesk" type="xs:integer"/>
119         </xs:sequence>
120     </xs:complexType>
121     <xs:complexType name="resize">
122         <xs:sequence>
123             <xs:element name="drawContents" type="ob:yesorno"/>
124             <xs:element name="fourCorners" type="ob:yesorno"/>
125             <xs:element name="popupShow" type="ob:popupshow"/>
126             <xs:element name="popupPosition" type="ob:popupposition"/>
127         </xs:sequence>
128     </xs:complexType>
129     <xs:complexType name="dock">
130         <xs:sequence>
131             <xs:element name="position" type="ob:position"/>
132             <xs:element name="stacking" type="ob:stacking"/>
133             <xs:element name="direction" type="ob:direction"/>
134             <xs:element name="floatingX" type="xs:integer"/>
135             <xs:element name="floatingY" type="xs:integer"/>
136             <xs:element name="autoHide" type="ob:yesorno"/>
137             <xs:element name="hideDelay" type="xs:integer"/>
138             <xs:element name="showDelay" type="xs:integer"/>
139             <xs:element name="moveButton" type="ob:button"/>
140             <xs:element name="noStrut" type="ob:yesorno"/>
141         </xs:sequence>
142     </xs:complexType>
143     <xs:complexType name="action">
144         <xs:sequence>
145             <xs:element minOccurs="0" name="menu" type="xs:string"/>
146             <xs:element minOccurs="0" name="desktop" type="xs:integer"/>
147             <xs:element minOccurs="0" name="follow" type="ob:yesorno"/>
148             <xs:element minOccurs="0" name="execute" type="xs:string"/>
149             <xs:element minOccurs="0" name="group" type="ob:yesorno"/>
150             <xs:element minOccurs="0" name="dialog" type="ob:yesorno"/>
151         </xs:sequence>
152         <xs:attribute name="name" type="ob:actionname" use="required"/>
153     </xs:complexType>
154     <xs:complexType name="keybind">
155         <xs:sequence>
156             <xs:element maxOccurs="unbounded" name="action" type="ob:action"/>
157         </xs:sequence>
158         <xs:attribute name="key" type="ob:keyname" use="required"/>
159     </xs:complexType>
160     <xs:complexType name="keyboard">
161         <xs:sequence>
162             <xs:element name="chainQuitKey" type="ob:keyname"/>
163             <xs:element maxOccurs="unbounded" name="keybind" type="ob:keybind"/>
164         </xs:sequence>
165     </xs:complexType>
166     <xs:complexType name="mousebind">
167         <xs:sequence>
168             <xs:element maxOccurs="unbounded" name="action" type="ob:action"/>
169         </xs:sequence>
170         <xs:attribute name="action" type="ob:mouseaction" use="required"/>
171         <xs:attribute name="button" type="ob:button" use="required"/>
172     </xs:complexType>
173     <xs:complexType name="context">
174         <xs:sequence>
175             <xs:element maxOccurs="unbounded" name="mousebind" type="ob:mousebind"/>
176         </xs:sequence>
177         <xs:attribute name="name" type="ob:contextname" use="required"/>
178     </xs:complexType>
179     <xs:complexType name="mouse">
180         <xs:sequence>
181             <xs:element name="dragThreshold" type="xs:integer"/>
182             <xs:element name="doubleClickTime" type="xs:integer"/>
183             <xs:element maxOccurs="unbounded" name="context" type="ob:context"/>
184         </xs:sequence>
185     </xs:complexType>
186     <xs:complexType name="menu">
187         <xs:sequence>
188             <xs:element maxOccurs="unbounded" name="file" type="xs:string"/>
189             <xs:element name="warpPointer" type="ob:yesorno"/>
190             <xs:element name="xorStyle" type="ob:yesorno"/>
191             <xs:element name="hideDelay" type="xs:integer"/>
192             <xs:element name="desktopMenuIcons" type="ob:yesorno"/>
193         </xs:sequence>
194     </xs:complexType>
195     <!--
196          simple types / restrictions
197       -->
198     <xs:simpleType name="yesorno">
199         <xs:restriction base="xs:string">
200             <xs:enumeration value="yes"/>
201             <xs:enumeration value="no"/>
202         </xs:restriction>
203     </xs:simpleType>
204     <xs:simpleType name="placementpolicy">
205         <xs:restriction base="xs:string">
206             <xs:enumeration value="Smart"/>
207             <xs:enumeration value="UnderMouse"/>
208         </xs:restriction>
209     </xs:simpleType>
210     <xs:simpleType name="popupshow">
211         <xs:restriction base="xs:string">
212             <xs:enumeration value="Always"/>
213             <xs:enumeration value="Never"/>
214             <xs:enumeration value="Nonpixel"/>
215         </xs:restriction>
216     </xs:simpleType>
217     <xs:simpleType name="popupposition">
218         <xs:restriction base="xs:string">
219             <xs:enumeration value="Top"/>
220             <xs:enumeration value="Center"/>
221         </xs:restriction>
222     </xs:simpleType>
223     <xs:simpleType name="position">
224         <xs:restriction base="xs:string">
225             <xs:enumeration value="TopLeft"/>
226             <xs:enumeration value="Top"/>
227             <xs:enumeration value="TopRight"/>
228             <xs:enumeration value="Right"/>
229             <xs:enumeration value="BottomRight"/>
230             <xs:enumeration value="Bottom"/>
231             <xs:enumeration value="BottomLeft"/>
232             <xs:enumeration value="Left"/>
233             <xs:enumeration value="Floating"/>
234         </xs:restriction>
235     </xs:simpleType>
236     <xs:simpleType name="stacking">
237         <xs:restriction base="xs:string">
238             <xs:enumeration value="Top"/>
239             <xs:enumeration value="Normal"/>
240             <xs:enumeration value="Bottom"/>
241         </xs:restriction>
242     </xs:simpleType>
243     <xs:simpleType name="direction">
244         <xs:restriction base="xs:string">
245             <xs:enumeration value="Horizontal"/>
246             <xs:enumeration value="Vertical"/>
247         </xs:restriction>
248     </xs:simpleType>
249     <xs:simpleType name="keyname">
250         <xs:restriction base="xs:string">
251             <xs:pattern value="(A-)?(S-)?(A-)?(C-)?(A-)?(S-)?(A-)?[a-zA-Z0-9]*"/>
252         </xs:restriction>
253     </xs:simpleType>
254     <xs:simpleType name="contextname">
255         <xs:restriction base="xs:string">
256             <xs:enumeration value="Desktop"/>
257             <xs:enumeration value="Client"/>
258             <xs:enumeration value="Titlebar"/>
259             <xs:enumeration value="Handle"/>
260             <xs:enumeration value="Frame"/>
261             <xs:enumeration value="TLCorner"/>
262             <xs:enumeration value="TRCorner"/>
263             <xs:enumeration value="BLCorner"/>
264             <xs:enumeration value="BRCorner"/>
265             <xs:enumeration value="Maximize"/>
266             <xs:enumeration value="AllDesktops"/>
267             <xs:enumeration value="Shade"/>
268             <xs:enumeration value="Iconify"/>
269             <xs:enumeration value="Icon"/>
270             <xs:enumeration value="Close"/>
271             <xs:enumeration value="MoveResize"/>
272         </xs:restriction>
273     </xs:simpleType>
274     <xs:simpleType name="button">
275         <xs:restriction base="xs:string">
276             <xs:enumeration value="Left"/>
277             <xs:enumeration value="Middle"/>
278             <xs:enumeration value="Right"/>
279             <xs:enumeration value="Up"/>
280             <xs:enumeration value="Down"/>
281             <xs:enumeration value="A-Left"/>
282             <xs:enumeration value="A-Middle"/>
283             <xs:enumeration value="A-Right"/>
284             <xs:enumeration value="A-Up"/>
285             <xs:enumeration value="A-Down"/>
286             <xs:enumeration value="C-A-Left"/>
287             <xs:enumeration value="C-A-Middle"/>
288             <xs:enumeration value="C-A-Right"/>
289             <xs:enumeration value="C-A-Up"/>
290             <xs:enumeration value="C-A-Down"/>
291         </xs:restriction>
292     </xs:simpleType>
293     <xs:simpleType name="mouseaction">
294         <xs:restriction base="xs:string">
295             <xs:enumeration value="Click"/>
296             <xs:enumeration value="DoubleClick"/>
297             <xs:enumeration value="Drag"/>
298             <xs:enumeration value="Press"/>
299             <xs:enumeration value="Release"/>
300         </xs:restriction>
301     </xs:simpleType>
302     <xs:simpleType name="actionname">
303         <xs:restriction base="xs:string">
304             <xs:enumeration value="Activate"/>
305             <xs:enumeration value="Close"/>
306             <xs:enumeration value="Desktop"/>
307             <xs:enumeration value="DesktopDown"/>
308             <xs:enumeration value="DesktopLast"/>
309             <xs:enumeration value="DesktopLeft"/>
310             <xs:enumeration value="DesktopNext"/>
311             <xs:enumeration value="DesktopPrevious"/>
312             <xs:enumeration value="DesktopRight"/>
313             <xs:enumeration value="DesktopUp"/>
314             <xs:enumeration value="DirectionalFocusEast"/>
315             <xs:enumeration value="DirectionalFocusNorth"/>
316             <xs:enumeration value="DirectionalFocusNortheast"/>
317             <xs:enumeration value="DirectionalFocusNorthwest"/>
318             <xs:enumeration value="DirectionalFocusSouth"/>
319             <xs:enumeration value="DirectionalFocusSoutheast"/>
320             <xs:enumeration value="DirectionalFocusSouthwest"/>
321             <xs:enumeration value="DirectionalFocusWest"/>
322             <xs:enumeration value="Execute"/>
323             <xs:enumeration value="Exit"/>
324             <xs:enumeration value="Focus"/>
325             <xs:enumeration value="FocusToBottom"/>
326             <xs:enumeration value="GrowToEdgeEast"/>
327             <xs:enumeration value="GrowToEdgeNorth"/>
328             <xs:enumeration value="GrowToEdgeSouth"/>
329             <xs:enumeration value="GrowToEdgeWest"/>
330             <xs:enumeration value="Iconify"/>
331             <xs:enumeration value="Kill"/>
332             <xs:enumeration value="Lower"/>
333             <xs:enumeration value="MaximizeFull"/>
334             <xs:enumeration value="MaximizeHorz"/>
335             <xs:enumeration value="MaximizeVert"/>
336             <xs:enumeration value="Move"/>
337             <xs:enumeration value="MoveRelativeHorz"/>
338             <xs:enumeration value="MoveRelativeVert"/>
339             <xs:enumeration value="MoveToEdgeEast"/>
340             <xs:enumeration value="MoveToEdgeNorth"/>
341             <xs:enumeration value="MoveToEdgeSouth"/>
342             <xs:enumeration value="MoveToEdgeWest"/>
343             <xs:enumeration value="MoveToCenter"/>
344             <xs:enumeration value="NextWindow"/>
345             <xs:enumeration value="NextWindowLinear"/>
346             <xs:enumeration value="PreviousWindow"/>
347             <xs:enumeration value="PreviousWindowLinear"/>
348             <xs:enumeration value="Raise"/>
349             <xs:enumeration value="RaiseLower"/>
350             <xs:enumeration value="Resize"/>
351             <xs:enumeration value="ResizeRelativeHorz"/>
352             <xs:enumeration value="ResizeRelativeVert"/>
353             <xs:enumeration value="Restart"/>
354             <xs:enumeration value="SendToBottomLayer"/>
355             <xs:enumeration value="SendToDesktop"/>
356             <xs:enumeration value="SendToDesktopDown"/>
357             <xs:enumeration value="SendToDesktopLeft"/>
358             <xs:enumeration value="SendToDesktopNext"/>
359             <xs:enumeration value="SendToDesktopPrevious"/>
360             <xs:enumeration value="SendToDesktopRight"/>
361             <xs:enumeration value="SendToDesktopUp"/>
362             <xs:enumeration value="SendToNormalLayer"/>
363             <xs:enumeration value="SendToTopLayer"/>
364             <xs:enumeration value="Shade"/>
365             <xs:enumeration value="ShadeLower"/>
366             <xs:enumeration value="ShowDesktop"/>
367             <xs:enumeration value="ShowMenu"/>
368             <xs:enumeration value="ToggleAlwaysOnBottom"/>
369             <xs:enumeration value="ToggleAlwaysOnTop"/>
370             <xs:enumeration value="ToggleDecorations"/>
371             <xs:enumeration value="ToggleFullscreen"/>
372             <xs:enumeration value="ToggleMaximizeFull"/>
373             <xs:enumeration value="ToggleMaximizeHorz"/>
374             <xs:enumeration value="ToggleMaximizeVert"/>
375             <xs:enumeration value="ToggleOmnipresent"/>
376             <xs:enumeration value="ToggleShade"/>
377             <xs:enumeration value="ToggleShowDesktop"/>
378             <xs:enumeration value="Unfocus"/>
379             <xs:enumeration value="UnmaximizeFull"/>
380             <xs:enumeration value="UnmaximizeHorz"/>
381             <xs:enumeration value="UnmaximizeVert"/>
382             <xs:enumeration value="Unshade"/>
383             <xs:enumeration value="UnshadeRaise"/>
384             <xs:enumeration value="UnShowDesktop"/>
385         </xs:restriction>
386     </xs:simpleType>
387 </xs:schema>