git.demorecorder.com Git - free-sw/xcb/proto/blob - src/xprint.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!--
   3 Copyright (C) 2005 Jeremy Kolb.
   4 All Rights Reserved.
   5
   6 Permission is hereby granted, free of charge, to any person ob/Sintaining a copy
   7 of this software and associated documentation files (the "Software"), to deal
   8 in the Software without restriction, including without limitation the rights
   9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  10 copies of the Software, and to permit persons to whom the Software is
  11 furnished to do so, subject to the following conditions:
  12
  13 The above copyright notice and this permission notice shall be included in all
  14 copies or substantial portions of the Software.
  15
  16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19 AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  20 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  21 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  22
  23 Except as contained in this notice, the names of the authors or their
  24 institutions shall not be used in advertising or otherwise to promote the
  25 sale, use or other dealings in this Software without prior written
  26 authorization from the authors.
  27 -->
  28
  29 <xcb header="xprint" extension-xname="XpExtension" extension-name="XP">
  30     <!-- Conforms to XPRINT 1.0 -->
  31
  32     <import>xproto</import>
  33
  34     <!-- Types -->
  35     <struct name="PRINTER">
  36         <field type="CARD32" name="nameLen" />
  37         <list type="STRING8" name="name">
  38             <fieldref>nameLen</fieldref>
  39         </list>
  40         <!-- Padding -->
  41         <field type="CARD32" name="descLen" />
  42         <list type="STRING8" name="description">
  43             <fieldref>descLen</fieldref>
  44         </list>
  45         <!-- More padding -->
  46     </struct>
  47
  48     <!--<typedef oldname="CARD32" newname="PCONTEXT" />-->
  49     <xidtype name="PCONTEXT" />
  50     <typedef oldname="char" newname="STRING8" />
  51
  52     <!-- "PrintGetDocumentData" -->
  53     <enum name="GetDoc">
  54         <item name="Finished"><value>0</value></item>
  55             <item name="SecondConsumer"><value>1</value></item>
  56     </enum>
  57
  58     <!-- Event Mask ("PrintSelectInput") -->
  59     <enum name="EvMask">
  60         <item name="NoEventMask"><value>0x00000000</value></item>
  61         <item name="PrintMask"><value>0x00000001</value></item>
  62         <item name="AttributeMask"><value>0x00000002</value></item>
  63     </enum>
  64
  65     <!-- "PrintNotify" detail -->
  66     <enum name="Detail">
  67         <item name="StartJobNotify"><value>1</value></item>
  68         <item name="EndJobNotify"><value>2</value></item>
  69         <item name="StartDocNotify"><value>3</value></item>
  70         <item name="EndDocNotify"><value>4</value></item>
  71         <item name="StartPageNotify"><value>5</value></item>
  72         <item name="EndPageNotify"><value>6</value></item>
  73     </enum>
  74
  75     <!-- "AttributeNotify" detail -->
  76     <enum name="Attr">
  77         <item name="JobAttr"><value>1</value></item>
  78         <item name="DocAttr"><value>2</value></item>
  79         <item name="PageAttr"><value>3</value></item>
  80         <item name="PrinterAttr"><value>4</value></item>
  81         <item name="ServerAttr"><value>5</value></item>
  82         <item name="MediumAttr"><value>6</value></item>
  83         <item name="SpoolerAttr"><value>7</value></item>
  84     </enum>
  85
  86
  87     <!-- Requests -->
  88     <request name="PrintQueryVersion" opcode="0">
  89         <reply>
  90             <pad bytes="1" />
  91             <field type="CARD16" name="major_version" />
  92             <field type="CARD16" name="minor_version" />
  93         </reply>
  94     </request>
  95
  96     <request name="PrintGetPrinterList" opcode="1">
  97         <field type="CARD32" name="printerNameLen" />
  98         <field type="CARD32" name="localeLen" />
  99         <list type="STRING8" name="printer_name">
 100             <fieldref>printerNameLen</fieldref>
 101         </list>
 102         <!-- There's some padding in here... -->
 103         <list type="STRING8" name="locale">
 104             <fieldref>localeLen</fieldref>
 105         </list>
 106         <reply>
 107             <pad bytes="1" />
 108             <field type="CARD32" name="listCount" />
 109             <pad bytes="20" />
 110             <list type="PRINTER" name="printers">
 111                 <fieldref>listCount</fieldref>
 112             </list>
 113         </reply>
 114     </request>
 115
 116     <request name="PrintRehashPrinterList" opcode="20" />
 117
 118     <request name="CreateContext" opcode="2">
 119         <field type="CARD32" name="context_id" />
 120         <field type="CARD32" name="printerNameLen" />
 121         <field type="CARD32" name="localeLen" />
 122         <list type="STRING8" name="printerName">
 123             <fieldref>printerNameLen</fieldref>
 124         </list>
 125         <!-- padding -->
 126         <list type="STRING8" name="locale">
 127             <fieldref>localeLen</fieldref>
 128         </list>
 129     </request>
 130
 131     <request name="PrintSetContext" opcode="3">
 132         <field type="CARD32" name="context" />
 133     </request>
 134
 135     <request name="PrintGetContext" opcode="4">
 136         <reply>
 137             <pad bytes="1" />
 138             <field type="CARD32" name="context" />
 139         </reply>
 140     </request>
 141
 142     <request name="PrintDestroyContext" opcode="5">
 143         <field type="CARD32" name="context" />
 144     </request>
 145
 146     <request name="PrintGetScreenOfContext" opcode="6">
 147         <reply>
 148             <pad bytes="1" />
 149             <field type="WINDOW" name="root" />
 150         </reply>
 151     </request>
 152
 153     <request name="PrintStartJob" opcode="7">
 154         <field type="CARD8" name="output_mode"/>
 155     </request>
 156
 157     <request name="PrintEndJob" opcode="8">
 158         <field type="BOOL"  name="cancel" />
 159     </request>
 160
 161     <request name="PrintStartDoc" opcode="9">
 162         <field type="CARD8" name="driver_mode" />
 163     </request>
 164
 165     <request name="PrintEndDoc" opcode="10">
 166         <field type="BOOL" name="cancel" />
 167     </request>
 168
 169     <request name="PrintPutDocumentData" opcode="11">
 170         <field type="DRAWABLE" name="drawable" />
 171         <field type="CARD32" name="len_data" />
 172         <field type="CARD16" name="len_fmt" />
 173         <field type="CARD16" name="len_options" />
 174         <list type="BYTE" name="data">
 175             <fieldref>len_data</fieldref>
 176         </list>
 177         <!-- padding -->
 178         <list type="STRING8" name="doc_format" />
 179         <!-- padding -->
 180         <list type="STRING8" name="options" />
 181     </request>
 182
 183     <request name="PrintGetDocumentData" opcode="12">
 184         <field type="PCONTEXT" name="context" />
 185         <field type="CARD32" name="max_bytes" />
 186         <reply>
 187             <pad bytes="1" />
 188             <field type="CARD32" name="status_code" />
 189             <field type="CARD32" name="finished_flag" />
 190             <field type="CARD32" name="dataLen" />
 191             <pad bytes="12" />
 192             <list type="BYTE" name="data">
 193                 <fieldref>dataLen</fieldref>
 194             </list>
 195         </reply>
 196     </request>
 197
 198     <request name="PrintStartPage" opcode="13">
 199         <field type="WINDOW" name="window" />
 200     </request>
 201
 202     <request name="PrintEndPage" opcode="14">
 203         <field type="BOOL" name="cancel" />
 204         <pad bytes="3" />
 205     </request>
 206
 207     <request name="PrintSelectInput" opcode="15">
 208         <field type="PCONTEXT" name="context" />
 209         <valueparam value-mask-type="CARD32"
 210                     value-mask-name="event_mask"
 211                     value-list-name="event_list" />
 212     </request>
 213
 214     <request name="PrintInputSelected" opcode="16">
 215         <field type="PCONTEXT" name="context" />
 216         <reply>
 217             <pad bytes="1" />
 218             <valueparam value-mask-type="CARD32"
 219                             value-mask-name="event_mask"
 220                             value-list-name="event_list" />
 221             <valueparam value-mask-type="CARD32"
 222                             value-mask-name="all_events_mask"
 223                             value-list-name="all_events_list" />
 224         </reply>
 225     </request>
 226
 227     <request name="PrintGetAttributes" opcode="17">
 228         <field type="PCONTEXT" name="context" />
 229         <field type="CARD8" name="pool" />
 230         <pad bytes="3" />
 231         <reply>
 232             <pad bytes="1" />
 233             <field type="CARD32" name="stringLen" />
 234             <pad bytes="20" />
 235             <field type="STRING8" name="attributes" />
 236         </reply>
 237     </request>
 238
 239     <request name="PrintGetOneAttributes" opcode="19">
 240         <field type="PCONTEXT" name="context" />
 241         <field type="CARD32" name="nameLen" />
 242         <field type="CARD8" name="pool" />
 243         <pad bytes="3" />
 244         <list type="STRING8" name="name">
 245             <fieldref>nameLen</fieldref>
 246         </list>
 247         <reply>
 248             <pad bytes="1" />
 249             <field type="CARD32" name="valueLen" />
 250             <pad bytes="20" />
 251             <list type="STRING8" name="value">
 252                 <fieldref>valueLen</fieldref>
 253             </list>
 254         </reply>
 255     </request>
 256
 257     <request name="PrintSetAttributes" opcode="18">
 258         <field type="PCONTEXT" name="context" />
 259         <field type="CARD32" name="stringLen" />
 260         <field type="CARD8" name="pool" />
 261         <field type="CARD8" name="rule" />
 262         <pad bytes="2" />
 263         <list type="STRING8" name="attributes" />
 264     </request>
 265
 266     <request name="PrintGetPageDimensions" opcode="21">
 267         <field type="PCONTEXT" name="context" />
 268         <reply>
 269             <pad bytes="1" />
 270             <field type="CARD16" name="width" />
 271             <field type="CARD16" name="height" />
 272             <field type="CARD16" name="offset_x" />
 273             <field type="CARD16" name="offset_y" />
 274             <field type="CARD16" name="reproducible_width" />
 275             <field type="CARD16" name="reproducible_height" />
 276         </reply>
 277     </request>
 278
 279     <request name="PrintQueryScreens" opcode="22">
 280         <reply>
 281             <pad bytes="1" />
 282             <field type="CARD32" name="listCount" />
 283             <pad bytes="20" />
 284             <list type="WINDOW" name="roots">
 285                 <fieldref>listCount</fieldref>
 286             </list>
 287             <!-- There may be a WINDOW rootWindow here... -->
 288         </reply>
 289     </request>
 290
 291     <request name="PrintSetImageResolution" opcode="23">
 292         <field type="PCONTEXT" name="context" />
 293         <field type="CARD16" name="image_resolution" />
 294         <reply>
 295             <field type="BOOL" name="status" />
 296             <field type="CARD16" name="previous_resolutions" />
 297         </reply>
 298     </request>
 299
 300     <request name="PrintGetImageResolution" opcode="24">
 301         <field type="PCONTEXT" name="context" />
 302         <reply>
 303             <pad bytes="1" />
 304             <field type="CARD16" name="image_resolution" />
 305         </reply>
 306     </request>
 307
 308
 309     <!-- Events -->
 310     <event name="Notify" number="0">
 311         <field type="CARD8" name="detail" />
 312         <field type="PCONTEXT" name="context" />
 313         <field type="BOOL" name="cancel" />
 314     </event>
 315
 316     <event name="AttributNotify" number="1">
 317         <field type="CARD8" name="detail" />
 318         <field type="PCONTEXT" name="context" />
 319     </event>
 320
 321     <!-- Errors -->
 322     <error name="BadContext" number="0" />
 323     <error name="BadSequence" number="1" />
 324
 325 </xcb>
 326