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="desktop" type="xs:integer"/>
 155             <xs:element minOccurs="0" name="wrap" type="ob:bool"/>
 156             <xs:element minOccurs="0" name="follow" type="ob:bool"/>
 157             <xs:element minOccurs="0" name="dialog" type="ob:bool"/>
 158             <xs:element minOccurs="0" name="here" type="ob:bool"/>
 159             <xs:element minOccurs="0" name="linear" type="ob:bool"/>
 160             <xs:element minOccurs="0" name="group" type="ob:bool"/>
 161         </xs:sequence>
 162         <xs:attribute name="name" type="ob:actionname" use="required"/>
 163     </xs:complexType>
 164     <xs:complexType name="keybind">
 165         <xs:sequence>
 166             <xs:element maxOccurs="unbounded" name="action" type="ob:action"/>
 167         </xs:sequence>
 168         <xs:attribute name="key" type="ob:keyname" use="required"/>
 169     </xs:complexType>
 170     <xs:complexType name="keyboard">
 171         <xs:sequence>
 172             <xs:element minOccurs="0" name="chainQuitKey" type="ob:keyname"/>
 173             <xs:element maxOccurs="unbounded" name="keybind" type="ob:keybind"/>
 174         </xs:sequence>
 175     </xs:complexType>
 176     <xs:complexType name="mousebind">
 177         <xs:sequence>
 178             <xs:element maxOccurs="unbounded" name="action" type="ob:action"/>
 179         </xs:sequence>
 180         <xs:attribute name="action" type="ob:mouseaction" use="required"/>
 181         <xs:attribute name="button" type="ob:button" use="required"/>
 182     </xs:complexType>
 183     <xs:complexType name="context">
 184         <xs:sequence>
 185             <xs:element maxOccurs="unbounded" name="mousebind" type="ob:mousebind"/>
 186         </xs:sequence>
 187         <xs:attribute name="name" type="ob:contextname" use="required"/>
 188     </xs:complexType>
 189     <xs:complexType name="mouse">
 190         <xs:sequence>
 191             <xs:element minOccurs="0" name="dragThreshold" type="xs:integer"/>
 192             <xs:element minOccurs="0" name="doubleClickTime" type="xs:integer"/>
 193             <xs:element maxOccurs="unbounded" name="context" type="ob:context"/>
 194         </xs:sequence>
 195     </xs:complexType>
 196     <xs:complexType name="menu">
 197         <xs:sequence>
 198             <xs:element maxOccurs="unbounded" name="file" type="xs:string"/>
 199             <xs:element minOccurs="0" name="warpPointer" type="ob:bool"/>
 200             <xs:element minOccurs="0" name="xorStyle" type="ob:bool"/>
 201             <xs:element minOccurs="0" name="hideDelay" type="xs:integer"/>
 202             <xs:element minOccurs="0" name="submenuShowDelay" type="xs:integer"/>
 203             <xs:element minOccurs="0" name="desktopMenuIcons" type="ob:bool"/>
 204         </xs:sequence>
 205     </xs:complexType>
 206     <xs:complexType name="window_position">
 207         <xs:sequence>
 208             <xs:element name="x" type="ob:center_or_int"/>
 209             <xs:element name="y" type="ob:center_or_int"/>
 210         </xs:sequence>
 211     </xs:complexType>
 212     <xs:complexType name="application">
 213         <xs:sequence>
 214             <xs:element minOccurs="0" name="decor" type="xs:string"/>
 215             <xs:element minOccurs="0" name="shade" type="ob:bool"/>
 216             <xs:element minOccurs="0" name="position" type="ob:window_position"/>
 217             <xs:element minOccurs="0" name="focus" type="xs:string"/>
 218             <xs:element minOccurs="0" name="desktop" type="xs:integer"/>
 219             <xs:element minOccurs="0" name="head" type="xs:string"/>
 220             <xs:element minOccurs="0" name="layer" type="ob:layer"/>
 221             <xs:element minOccurs="0" name="iconic" type="ob:bool"/>
 222             <xs:element minOccurs="0" name="skip_pager" type="ob:bool"/>
 223             <xs:element minOccurs="0" name="skip_taskbar" type="ob:bool"/>
 224             <xs:element minOccurs="0" name="fullscreen" type="ob:bool"/>
 225             <xs:element minOccurs="0" name="maximized" type="ob:maximization"/>
 226         </xs:sequence>
 227         <!-- at least one of these must be present -->
 228         <xs:attribute name="name" type="xs:string"/>
 229         <xs:attribute name="class" type="xs:string"/>
 230         <xs:attribute name="role" type="xs:string"/>
 231     </xs:complexType>
 232     <xs:complexType name="applications">
 233         <xs:sequence>
 234             <xs:element minOccurs="0" maxOccurs="unbounded" name="application" type="ob:application"/>
 235         </xs:sequence>
 236     </xs:complexType>
 237     <!--
 238          simple types / restrictions
 239       -->
 240     <xs:simpleType name="actionname">
 241         <xs:restriction base="xs:string">
 242             <xs:enumeration value="Activate"/>
 243             <xs:enumeration value="Close"/>
 244             <xs:enumeration value="Desktop"/>
 245             <xs:enumeration value="DesktopDown"/>
 246             <xs:enumeration value="DesktopLast"/>
 247             <xs:enumeration value="DesktopLeft"/>
 248             <xs:enumeration value="DesktopNext"/>
 249             <xs:enumeration value="DesktopPrevious"/>
 250             <xs:enumeration value="DesktopRight"/>
 251             <xs:enumeration value="DesktopUp"/>
 252             <xs:enumeration value="DirectionalFocusEast"/>
 253             <xs:enumeration value="DirectionalFocusNorth"/>
 254             <xs:enumeration value="DirectionalFocusNortheast"/>
 255             <xs:enumeration value="DirectionalFocusNorthwest"/>
 256             <xs:enumeration value="DirectionalFocusSouth"/>
 257             <xs:enumeration value="DirectionalFocusSoutheast"/>
 258             <xs:enumeration value="DirectionalFocusSouthwest"/>
 259             <xs:enumeration value="DirectionalFocusWest"/>
 260             <xs:enumeration value="Execute"/>
 261             <xs:enumeration value="Exit"/>
 262             <xs:enumeration value="Focus"/>
 263             <xs:enumeration value="FocusToBottom"/>
 264             <xs:enumeration value="GrowToEdgeEast"/>
 265             <xs:enumeration value="GrowToEdgeNorth"/>
 266             <xs:enumeration value="GrowToEdgeSouth"/>
 267             <xs:enumeration value="GrowToEdgeWest"/>
 268             <xs:enumeration value="Iconify"/>
 269             <xs:enumeration value="Kill"/>
 270             <xs:enumeration value="Lower"/>
 271             <xs:enumeration value="MaximizeFull"/>
 272             <xs:enumeration value="MaximizeHorz"/>
 273             <xs:enumeration value="MaximizeVert"/>
 274             <xs:enumeration value="Move"/>
 275             <xs:enumeration value="MoveRelativeHorz"/>
 276             <xs:enumeration value="MoveRelativeVert"/>
 277             <xs:enumeration value="MoveToCenter"/>
 278             <xs:enumeration value="MoveToEdgeEast"/>
 279             <xs:enumeration value="MoveToEdgeNorth"/>
 280             <xs:enumeration value="MoveToEdgeSouth"/>
 281             <xs:enumeration value="MoveToEdgeWest"/>
 282             <xs:enumeration value="NextWindow"/>
 283             <xs:enumeration value="PreviousWindow"/>
 284             <xs:enumeration value="Raise"/>
 285             <xs:enumeration value="RaiseLower"/>
 286             <xs:enumeration value="Reconfigure"/>
 287             <xs:enumeration value="Resize"/>
 288             <xs:enumeration value="ResizeRelativeHorz"/>
 289             <xs:enumeration value="ResizeRelativeVert"/>
 290             <xs:enumeration value="Restart"/>
 291             <xs:enumeration value="SendToBottomLayer"/>
 292             <xs:enumeration value="SendToDesktop"/>
 293             <xs:enumeration value="SendToDesktopDown"/>
 294             <xs:enumeration value="SendToDesktopLeft"/>
 295             <xs:enumeration value="SendToDesktopNext"/>
 296             <xs:enumeration value="SendToDesktopPrevious"/>
 297             <xs:enumeration value="SendToDesktopRight"/>
 298             <xs:enumeration value="SendToDesktopUp"/>
 299             <xs:enumeration value="SendToNormalLayer"/>
 300             <xs:enumeration value="SendToTopLayer"/>
 301             <xs:enumeration value="Shade"/>
 302             <xs:enumeration value="ShadeLower"/>
 303             <xs:enumeration value="ShowDesktop"/>
 304             <xs:enumeration value="ShowMenu"/>
 305             <xs:enumeration value="ToggleAlwaysOnBottom"/>
 306             <xs:enumeration value="ToggleAlwaysOnTop"/>
 307             <xs:enumeration value="ToggleDecorations"/>
 308             <xs:enumeration value="ToggleDockAutoHide"/>
 309             <xs:enumeration value="ToggleFullscreen"/>
 310             <xs:enumeration value="ToggleMaximizeFull"/>
 311             <xs:enumeration value="ToggleMaximizeHorz"/>
 312             <xs:enumeration value="ToggleMaximizeVert"/>
 313             <xs:enumeration value="ToggleOmnipresent"/>
 314             <xs:enumeration value="ToggleShade"/>
 315             <xs:enumeration value="ToggleShowDesktop"/>
 316             <xs:enumeration value="Unfocus"/>
 317             <xs:enumeration value="UnmaximizeFull"/>
 318             <xs:enumeration value="UnmaximizeHorz"/>
 319             <xs:enumeration value="UnmaximizeVert"/>
 320             <xs:enumeration value="Unshade"/>
 321             <xs:enumeration value="UnshadeRaise"/>
 322             <xs:enumeration value="UnShowDesktop"/>
 323         </xs:restriction>
 324     </xs:simpleType>
 325     <xs:simpleType name="bool">
 326         <!-- this is copied to maximization.  Keep that in sync. -->
 327         <xs:restriction base="xs:string">
 328             <xs:enumeration value="yes"/>
 329             <xs:enumeration value="no"/>
 330             <xs:enumeration value="true"/>
 331             <xs:enumeration value="false"/>
 332             <xs:enumeration value="on"/>
 333             <xs:enumeration value="off"/>
 334         </xs:restriction>
 335     </xs:simpleType>
 336     <xs:simpleType name="button">
 337         <xs:restriction base="xs:string">
 338             <xs:enumeration value="Left"/>
 339             <xs:enumeration value="Middle"/>
 340             <xs:enumeration value="Right"/>
 341             <xs:enumeration value="Up"/>
 342             <xs:enumeration value="Down"/>
 343             <xs:enumeration value="A-Left"/>
 344             <xs:enumeration value="A-Middle"/>
 345             <xs:enumeration value="A-Right"/>
 346             <xs:enumeration value="A-Up"/>
 347             <xs:enumeration value="A-Down"/>
 348             <xs:enumeration value="C-A-Left"/>
 349             <xs:enumeration value="C-A-Middle"/>
 350             <xs:enumeration value="C-A-Right"/>
 351             <xs:enumeration value="C-A-Up"/>
 352             <xs:enumeration value="C-A-Down"/>
 353         </xs:restriction>
 354     </xs:simpleType>
 355     <xs:simpleType name="center_or_int">
 356         <xs:restriction base="xs:string">
 357             <!-- ob: atoi($_) unless $_ eq 'center'; -->
 358             <!-- I think the regexp DTRT WRT atoi. -->
 359             <xs:pattern value="center|0|[1-9][0-9]*"/>
 360         </xs:restriction>
 361     </xs:simpleType>
 362     <xs:simpleType name="contextname">
 363         <xs:restriction base="xs:string">
 364             <xs:enumeration value="Desktop"/>
 365             <xs:enumeration value="Client"/>
 366             <xs:enumeration value="Titlebar"/>
 367             <xs:enumeration value="Handle"/>
 368             <xs:enumeration value="Frame"/>
 369             <xs:enumeration value="TLCorner"/>
 370             <xs:enumeration value="TRCorner"/>
 371             <xs:enumeration value="BLCorner"/>
 372             <xs:enumeration value="BRCorner"/>
 373             <xs:enumeration value="Maximize"/>
 374             <xs:enumeration value="AllDesktops"/>
 375             <xs:enumeration value="Shade"/>
 376             <xs:enumeration value="Iconify"/>
 377             <xs:enumeration value="Icon"/>
 378             <xs:enumeration value="Close"/>
 379             <xs:enumeration value="MoveResize"/>
 380         </xs:restriction>
 381     </xs:simpleType>
 382     <xs:simpleType name="direction">
 383         <xs:restriction base="xs:string">
 384             <xs:enumeration value="Horizontal"/>
 385             <xs:enumeration value="Vertical"/>
 386         </xs:restriction>
 387     </xs:simpleType>
 388     <xs:simpleType name="dock_position">
 389         <xs:restriction base="xs:string">
 390             <xs:enumeration value="TopLeft"/>
 391             <xs:enumeration value="Top"/>
 392             <xs:enumeration value="TopRight"/>
 393             <xs:enumeration value="Right"/>
 394             <xs:enumeration value="BottomRight"/>
 395             <xs:enumeration value="Bottom"/>
 396             <xs:enumeration value="BottomLeft"/>
 397             <xs:enumeration value="Left"/>
 398             <xs:enumeration value="Floating"/>
 399         </xs:restriction>
 400     </xs:simpleType>
 401     <xs:simpleType name="keyname">
 402         <xs:restriction base="xs:string">
 403             <!-- FIXME: M, Mod2, Mod5 in addition to S, A, C -->
 404             <!-- how do we do all substrings and permutations? -->
 405             <xs:pattern value="(A-)?(S-)?(A-)?(C-)?(A-)?(S-)?(A-)?[a-zA-Z0-9]*"/>
 406         </xs:restriction>
 407     </xs:simpleType>
 408     <xs:simpleType name="layer">
 409         <xs:restriction base="xs:string">
 410             <xs:enumeration value="Top"/>
 411             <xs:enumeration value="Normal"/>
 412             <xs:enumeration value="Bottom"/>
 413         </xs:restriction>
 414     </xs:simpleType>
 415     <xs:simpleType name="maximization">
 416         <xs:restriction base="xs:string">
 417             <xs:enumeration value="Horizontal"/>
 418             <xs:enumeration value="Vertical"/>
 419             <!-- this is a copy of ob:bool.  Keep it in sync. -->
 420             <xs:enumeration value="yes"/>
 421             <xs:enumeration value="no"/>
 422             <xs:enumeration value="true"/>
 423             <xs:enumeration value="false"/>
 424             <xs:enumeration value="on"/>
 425             <xs:enumeration value="off"/>
 426         </xs:restriction>
 427     </xs:simpleType>
 428     <xs:simpleType name="mouseaction">
 429         <xs:restriction base="xs:string">
 430             <xs:enumeration value="Click"/>
 431             <xs:enumeration value="DoubleClick"/>
 432             <xs:enumeration value="Drag"/>
 433             <xs:enumeration value="Press"/>
 434             <xs:enumeration value="Release"/>
 435         </xs:restriction>
 436     </xs:simpleType>
 437     <xs:simpleType name="placementpolicy">
 438         <xs:restriction base="xs:string">
 439             <xs:enumeration value="Smart"/>
 440             <xs:enumeration value="UnderMouse"/>
 441         </xs:restriction>
 442     </xs:simpleType>
 443     <xs:simpleType name="popupposition">
 444         <xs:restriction base="xs:string">
 445             <xs:enumeration value="Top"/>
 446             <xs:enumeration value="Center"/>
 447         </xs:restriction>
 448     </xs:simpleType>
 449     <xs:simpleType name="popupshow">
 450         <xs:restriction base="xs:string">
 451             <xs:enumeration value="Always"/>
 452             <xs:enumeration value="Never"/>
 453             <xs:enumeration value="Nonpixel"/>
 454         </xs:restriction>
 455     </xs:simpleType>
 456 </xs:schema>