data/rc.xsd

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