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