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