data/rc.xsd

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