data/rc.xsd

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