add option for under-mouse placement
[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 -->
30 <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema"
31     targetNamespace="http://openbox.org/"
32     xmlns:ob="http://openbox.org/"
33     elementFormDefault="qualified">
34     <!--
35          root node
36       -->
37     <xs:element name="openbox_config">
38         <xs:annotation>
39             <xs:documentation>all these elements are expected in a openbox config file</xs:documentation>
40         </xs:annotation>
41         <xs:complexType>
42             <xs:sequence>
43                 <xs:element name="resistance" type="ob:resistance"/>
44                 <xs:element name="focus" type="ob:focus"/>
45                 <xs:element name="placement" type="ob:placement"/>
46                 <xs:element name="theme" type="ob:theme"/>
47                 <xs:element name="desktops" type="ob:desktops"/>
48                 <xs:element name="resize" type="ob:resize"/>
49                 <xs:element name="dock" type="ob:dock"/>
50                 <xs:element name="keyboard" type="ob:keyboard"/>
51                 <xs:element name="mouse" type="ob:mouse"/>
52                 <xs:element name="menu" type="ob:menu"/>
53             </xs:sequence>
54         </xs:complexType>
55     </xs:element>
56     <!--
57          complex types
58       -->
59     <xs:complexType name="resistance">
60         <xs:annotation>
61             <xs:documentation>defines behaviour of windows when close to eachother or the screen edge</xs:documentation>
62         </xs:annotation>
63         <xs:sequence>
64             <xs:element name="strength" type="xs:integer"/>
65             <xs:element name="screen_edge_strength" type="xs:integer"/>
66         </xs:sequence>
67     </xs:complexType>
68     <xs:complexType name="focus">
69         <xs:annotation>
70             <xs:documentation>defines aspects of window focus</xs:documentation>
71         </xs:annotation>
72         <xs:sequence>
73             <xs:element name="focusNew" type="ob:yesorno"/>
74             <xs:element name="followMouse" type="ob:yesorno"/>
75             <xs:element name="focusDelay" type="xs:integer"/>
76             <xs:element name="raiseOnFocus" type="ob:yesorno"/>
77         </xs:sequence>
78     </xs:complexType>
79     <xs:complexType name="placement">
80         <xs:annotation>
81             <xs:documentation>defines how new windows are placed</xs:documentation>
82         </xs:annotation>
83         <xs:sequence>
84             <xs:element name="policy" type="ob:placementpolicy"/>
85         </xs:sequence>
86     </xs:complexType>
87     <xs:complexType name="theme">
88         <xs:sequence>
89             <xs:element name="name" type="xs:string"/>
90             <xs:element name="titlelayout" type="xs:string"/>
91         </xs:sequence>
92     </xs:complexType>
93     <xs:complexType name="desktops">
94         <xs:sequence>
95             <xs:element name="number" type="xs:integer"/>
96             <xs:element name="names">
97                 <xs:complexType>
98                     <xs:sequence>
99                         <xs:element maxOccurs="unbounded" name="name" type="xs:string"/>
100                     </xs:sequence>
101                 </xs:complexType>
102             </xs:element>
103         </xs:sequence>
104     </xs:complexType>
105     <xs:complexType name="resize">
106         <xs:sequence>
107             <xs:element name="drawContents" type="ob:yesorno"/>
108         </xs:sequence>
109     </xs:complexType>
110     <xs:complexType name="dock">
111         <xs:sequence>
112             <xs:element name="position" type="ob:position"/>
113             <xs:element name="stacking" type="ob:stacking"/>
114             <xs:element name="direction" type="ob:direction"/>
115             <xs:element name="floatingX" type="xs:integer"/>
116             <xs:element name="floatingY" type="xs:integer"/>
117             <xs:element name="autoHide" type="ob:yesorno"/>
118             <xs:element name="hideDelay" type="xs:integer"/>
119             <xs:element name="moveButton" type="ob:button"/>
120         </xs:sequence>
121     </xs:complexType>
122     <xs:complexType name="action">
123         <xs:sequence>
124             <xs:element minOccurs="0" name="menu" type="xs:string"/>
125             <xs:element minOccurs="0" name="desktop" type="xs:integer"/>
126             <xs:element minOccurs="0" name="follow" type="ob:yesorno"/>
127             <xs:element minOccurs="0" name="execute" type="xs:string"/>
128             <xs:element minOccurs="0" name="dialog" type="ob:yesorno"/>
129         </xs:sequence>
130         <xs:attribute name="name" type="ob:actionname" use="required"/>
131     </xs:complexType>
132     <xs:complexType name="keybind">
133         <xs:sequence>
134             <xs:element maxOccurs="unbounded" name="action" type="ob:action"/>
135         </xs:sequence>
136         <xs:attribute name="key" type="ob:keyname" use="required"/>
137     </xs:complexType>
138     <xs:complexType name="keyboard">
139         <xs:sequence>
140             <xs:element name="chainQuitKey" type="ob:keyname"/>
141             <xs:element maxOccurs="unbounded" name="keybind" type="ob:keybind"/>
142         </xs:sequence>
143     </xs:complexType>
144     <xs:complexType name="mousebind">
145         <xs:sequence>
146             <xs:element maxOccurs="unbounded" name="action" type="ob:action"/>
147         </xs:sequence>
148         <xs:attribute name="action" type="ob:mouseaction" use="required"/>
149         <xs:attribute name="button" type="ob:button" use="required"/>
150     </xs:complexType>
151     <xs:complexType name="context">
152         <xs:sequence>
153             <xs:element maxOccurs="unbounded" name="mousebind" type="ob:mousebind"/>
154         </xs:sequence>
155         <xs:attribute name="name" type="ob:contextname" use="required"/>
156     </xs:complexType>
157     <xs:complexType name="mouse">
158         <xs:sequence>
159             <xs:element name="dragThreshold" type="xs:integer"/>
160             <xs:element name="doubleClickTime" type="xs:integer"/>
161             <xs:element maxOccurs="unbounded" name="context" type="ob:context"/>
162         </xs:sequence>
163     </xs:complexType>
164     <xs:complexType name="menu">
165         <xs:sequence>
166             <xs:element maxOccurs="unbounded" name="file" type="xs:string"/>
167         </xs:sequence>
168     </xs:complexType>
169     <!--
170          simple types / restrictions
171       -->
172     <xs:simpleType name="yesorno">
173         <xs:restriction base="xs:string">
174             <xs:enumeration value="yes"/>
175             <xs:enumeration value="no"/>
176         </xs:restriction>
177     </xs:simpleType>
178     <xs:simpleType name="placementpolicy">
179         <xs:restriction base="xs:string">
180             <xs:enumeration value="Smart"/>
181             <xs:enumeration value="UnderMouse"/>
182         </xs:restriction>
183     </xs:simpleType>
184     <xs:simpleType name="position">
185         <xs:restriction base="xs:string">
186             <xs:enumeration value="TopLeft"/>
187             <xs:enumeration value="Top"/>
188             <xs:enumeration value="TopRight"/>
189             <xs:enumeration value="Right"/>
190             <xs:enumeration value="BottomRight"/>
191             <xs:enumeration value="Bottom"/>
192             <xs:enumeration value="BottomLeft"/>
193             <xs:enumeration value="Left"/>
194             <xs:enumeration value="Floating"/>
195         </xs:restriction>
196     </xs:simpleType>
197     <xs:simpleType name="stacking">
198         <xs:restriction base="xs:string">
199             <xs:enumeration value="Top"/>
200             <xs:enumeration value="Normal"/>
201             <xs:enumeration value="Bottom"/>
202         </xs:restriction>
203     </xs:simpleType>
204     <xs:simpleType name="direction">
205         <xs:restriction base="xs:string">
206             <xs:enumeration value="Horizontal"/>
207             <xs:enumeration value="Vertical"/>
208         </xs:restriction>
209     </xs:simpleType>
210     <xs:simpleType name="keyname">
211         <xs:restriction base="xs:string">
212             <xs:pattern value="(A-)?(S-)?(A-)?(C-)?(A-)?(S-)?(A-)?[a-zA-Z0-9]*"/>
213         </xs:restriction>
214     </xs:simpleType>
215     <xs:simpleType name="contextname">
216         <xs:restriction base="xs:string">
217             <xs:enumeration value="Desktop"/>
218             <xs:enumeration value="Client"/>
219             <xs:enumeration value="Titlebar"/>
220             <xs:enumeration value="Handle"/>
221             <xs:enumeration value="Frame"/>
222             <xs:enumeration value="TLCorner"/>
223             <xs:enumeration value="TRCorner"/>
224             <xs:enumeration value="BLCorner"/>
225             <xs:enumeration value="BRCorner"/>
226             <xs:enumeration value="Maximize"/>
227             <xs:enumeration value="AllDesktops"/>
228             <xs:enumeration value="Shade"/>
229             <xs:enumeration value="Iconify"/>
230             <xs:enumeration value="Icon"/>
231             <xs:enumeration value="Close"/>
232             <xs:enumeration value="MoveResize"/>
233         </xs:restriction>
234     </xs:simpleType>
235     <xs:simpleType name="button">
236         <xs:restriction base="xs:string">
237             <xs:enumeration value="Left"/>
238             <xs:enumeration value="Middle"/>
239             <xs:enumeration value="Right"/>
240             <xs:enumeration value="Up"/>
241             <xs:enumeration value="Down"/>
242             <xs:enumeration value="A-Left"/>
243             <xs:enumeration value="A-Middle"/>
244             <xs:enumeration value="A-Right"/>
245             <xs:enumeration value="A-Up"/>
246             <xs:enumeration value="A-Down"/>
247             <xs:enumeration value="C-A-Left"/>
248             <xs:enumeration value="C-A-Middle"/>
249             <xs:enumeration value="C-A-Right"/>
250             <xs:enumeration value="C-A-Up"/>
251             <xs:enumeration value="C-A-Down"/>
252         </xs:restriction>
253     </xs:simpleType>
254     <xs:simpleType name="mouseaction">
255         <xs:restriction base="xs:string">
256             <xs:enumeration value="Click"/>
257             <xs:enumeration value="DoubleClick"/>
258             <xs:enumeration value="Drag"/>
259             <xs:enumeration value="Press"/>
260             <xs:enumeration value="Release"/>
261         </xs:restriction>
262     </xs:simpleType>
263     <xs:simpleType name="actionname">
264         <xs:restriction base="xs:string">
265             <xs:enumeration value="Activate"/>
266             <xs:enumeration value="Close"/>
267             <xs:enumeration value="Desktop"/>
268             <xs:enumeration value="DesktopDown"/>
269             <xs:enumeration value="DesktopLast"/>
270             <xs:enumeration value="DesktopLeft"/>
271             <xs:enumeration value="DesktopNext"/>
272             <xs:enumeration value="DesktopPrevious"/>
273             <xs:enumeration value="DesktopRight"/>
274             <xs:enumeration value="DesktopUp"/>
275             <xs:enumeration value="DirectionalFocusEast"/>
276             <xs:enumeration value="DirectionalFocusNorth"/>
277             <xs:enumeration value="DirectionalFocusNortheast"/>
278             <xs:enumeration value="DirectionalFocusNorthwest"/>
279             <xs:enumeration value="DirectionalFocusSouth"/>
280             <xs:enumeration value="DirectionalFocusSoutheast"/>
281             <xs:enumeration value="DirectionalFocusSouthwest"/>
282             <xs:enumeration value="DirectionalFocusWest"/>
283             <xs:enumeration value="Execute"/>
284             <xs:enumeration value="Exit"/>
285             <xs:enumeration value="Focus"/>
286             <xs:enumeration value="GrowToEdgeEast"/>
287             <xs:enumeration value="GrowToEdgeNorth"/>
288             <xs:enumeration value="GrowToEdgeSouth"/>
289             <xs:enumeration value="GrowToEdgeWest"/>
290             <xs:enumeration value="Iconify"/>
291             <xs:enumeration value="Kill"/>
292             <xs:enumeration value="Lower"/>
293             <xs:enumeration value="MaximizeFull"/>
294             <xs:enumeration value="MaximizeHorz"/>
295             <xs:enumeration value="MaximizeVert"/>
296             <xs:enumeration value="Move"/>
297             <xs:enumeration value="MoveRelativeHorz"/>
298             <xs:enumeration value="MoveRelativeVert"/>
299             <xs:enumeration value="MoveToEdgeEast"/>
300             <xs:enumeration value="MoveToEdgeNorth"/>
301             <xs:enumeration value="MoveToEdgeSouth"/>
302             <xs:enumeration value="MoveToEdgeWest"/>
303             <xs:enumeration value="NextWindow"/>
304             <xs:enumeration value="NextWindowLinear"/>
305             <xs:enumeration value="PreviousWindow"/>
306             <xs:enumeration value="PreviousWindowLinear"/>
307             <xs:enumeration value="Raise"/>
308             <xs:enumeration value="RaiseLower"/>
309             <xs:enumeration value="Resize"/>
310             <xs:enumeration value="ResizeRelativeHorz"/>
311             <xs:enumeration value="ResizeRelativeVert"/>
312             <xs:enumeration value="Restart"/>
313             <xs:enumeration value="SendToBottomLayer"/>
314             <xs:enumeration value="SendToDesktop"/>
315             <xs:enumeration value="SendToDesktopDown"/>
316             <xs:enumeration value="SendToDesktopLeft"/>
317             <xs:enumeration value="SendToDesktopNext"/>
318             <xs:enumeration value="SendToDesktopPrevious"/>
319             <xs:enumeration value="SendToDesktopRight"/>
320             <xs:enumeration value="SendToDesktopUp"/>
321             <xs:enumeration value="SendToNormalLayer"/>
322             <xs:enumeration value="SendToTopLayer"/>
323             <xs:enumeration value="Shade"/>
324             <xs:enumeration value="ShadeLower"/>
325             <xs:enumeration value="ShowDesktop"/>
326             <xs:enumeration value="ShowMenu"/>
327             <xs:enumeration value="ToggleAlwaysOnBottom"/>
328             <xs:enumeration value="ToggleAlwaysOnTop"/>
329             <xs:enumeration value="ToggleDecorations"/>
330             <xs:enumeration value="ToggleMaximizeFull"/>
331             <xs:enumeration value="ToggleMaximizeHorz"/>
332             <xs:enumeration value="ToggleMaximizeVert"/>
333             <xs:enumeration value="ToggleOmnipresent"/>
334             <xs:enumeration value="ToggleShade"/>
335             <xs:enumeration value="ToggleShowDesktop"/>
336             <xs:enumeration value="Unfocus"/>
337             <xs:enumeration value="UnmaximizeFull"/>
338             <xs:enumeration value="UnmaximizeHorz"/>
339             <xs:enumeration value="UnmaximizeVert"/>
340             <xs:enumeration value="Unshade"/>
341             <xs:enumeration value="UnshadeRaise"/>
342             <xs:enumeration value="UnShowDesktop"/>
343         </xs:restriction>
344     </xs:simpleType>
345 </xs:schema>