xorg-server-1.4/hw/dmx/doc/html/dmxconsole_8h.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   2 <html>
   3   <head>
   4     <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
   5     <title>File Index</title>
   6     <link href="doxygen.css" rel="stylesheet" type="text/css">
   7   </head>
   8   <body>
   9 <!-- Generated by Doxygen 1.3.4 -->
  10 <div class="qindex"><a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
  11 <h1>dmxconsole.h File Reference</h1>
  12 <p>
  13 <a href="dmxconsole_8h-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
  14 <tr><td></td></tr>
  15 <tr><td colspan=2><br><h2>Functions</h2></td></tr>
  16 <tr><td class="memItemLeft" nowrap align=right valign=top>pointer&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a0">dmxConsoleCreatePrivate</a> (DeviceIntPtr pDevice)</td></tr>
  17
  18 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a1">dmxConsoleDestroyPrivate</a> (pointer private)</td></tr>
  19
  20 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a2">dmxConsoleInit</a> (DevicePtr pDev)</td></tr>
  21
  22 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a3">dmxConsoleReInit</a> (DevicePtr pDev)</td></tr>
  23
  24 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a4">dmxConsoleMouGetInfo</a> (DevicePtr pDev, <a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a> info)</td></tr>
  25
  26 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a5">dmxConsoleKbdGetInfo</a> (DevicePtr pDev, <a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a> info)</td></tr>
  27
  28 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a6">dmxConsoleCollectEvents</a> (DevicePtr pDev, dmxMotionProcPtr motion, dmxEnqueueProcPtr enqueue, dmxCheckSpecialProcPtr checkspecial, DMXBlockType block)</td></tr>
  29
  30 <tr><td class="memItemLeft" nowrap align=right valign=top>int&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a7">dmxConsoleFunctions</a> (pointer private, DMXFunctionType function)</td></tr>
  31
  32 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a8">dmxConsoleUpdatePosition</a> (pointer private, int x, int y)</td></tr>
  33
  34 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a10">dmxConsoleCapture</a> (<a class="el" href="struct__DMXInputInfo.html">DMXInputInfo</a> *dmxInput)</td></tr>
  35
  36 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a11">dmxConsoleUncapture</a> (<a class="el" href="struct__DMXInputInfo.html">DMXInputInfo</a> *dmxInput)</td></tr>
  37
  38 <tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="dmxconsole_8h.html#a12">dmxConsoleUpdateInfo</a> (pointer private, <a class="el" href="dmxinput_8h.html#a30">DMXUpdateType</a>, WindowPtr pWindow)</td></tr>
  39
  40 </table>
  41 <hr><a name="_details"></a><h2>Detailed Description</h2>
  42 Interface for console device support. <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="dmxconsole_8c.html">dmxconsole.c</a> <p>
  43 <a class="el" href="dmxcommon_8c.html">dmxcommon.c</a></dd></dl>
  44 <hr><h2>Function Documentation</h2>
  45 <a class="anchor" name="a10" doxytag="dmxconsole.h::dmxConsoleCapture" ></a><p>
  46 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  47   <tr>
  48     <td class="mdRow">
  49       <table cellpadding="0" cellspacing="0" border="0">
  50         <tr>
  51           <td class="md" nowrap valign="top"> void dmxConsoleCapture </td>
  52           <td class="md" valign="top">(&nbsp;</td>
  53           <td class="md" nowrap valign="top"><a class="el" href="struct__DMXInputInfo.html">DMXInputInfo</a> *&nbsp;</td>
  54           <td class="mdname1" valign="top" nowrap> <em>dmxInput</em>          </td>
  55           <td class="md" valign="top">&nbsp;)&nbsp;</td>
  56           <td class="md" nowrap></td>
  57         </tr>
  58
  59       </table>
  60     </td>
  61   </tr>
  62 </table>
  63 <table cellspacing=5 cellpadding=0 border=0>
  64   <tr>
  65     <td>
  66       &nbsp;
  67     </td>
  68     <td>
  69
  70 <p>
  71 This routine is used to warp the pointer into the console window from anywhere on the screen. It is used when backend and console input are both being taken from the same X display.     </td>
  72   </tr>
  73 </table>
  74 <a class="anchor" name="a6" doxytag="dmxconsole.h::dmxConsoleCollectEvents" ></a><p>
  75 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
  76   <tr>
  77     <td class="mdRow">
  78       <table cellpadding="0" cellspacing="0" border="0">
  79         <tr>
  80           <td class="md" nowrap valign="top"> void dmxConsoleCollectEvents </td>
  81           <td class="md" valign="top">(&nbsp;</td>
  82           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
  83           <td class="mdname" nowrap> <em>pDev</em>, </td>
  84         </tr>
  85         <tr>
  86           <td></td>
  87           <td></td>
  88           <td class="md" nowrap>dmxMotionProcPtr&nbsp;</td>
  89           <td class="mdname" nowrap> <em>motion</em>, </td>
  90         </tr>
  91         <tr>
  92           <td></td>
  93           <td></td>
  94           <td class="md" nowrap>dmxEnqueueProcPtr&nbsp;</td>
  95           <td class="mdname" nowrap> <em>enqueue</em>, </td>
  96         </tr>
  97         <tr>
  98           <td></td>
  99           <td></td>
 100           <td class="md" nowrap>dmxCheckSpecialProcPtr&nbsp;</td>
 101           <td class="mdname" nowrap> <em>checkspecial</em>, </td>
 102         </tr>
 103         <tr>
 104           <td></td>
 105           <td></td>
 106           <td class="md" nowrap>DMXBlockType&nbsp;</td>
 107           <td class="mdname" nowrap> <em>block</em></td>
 108         </tr>
 109         <tr>
 110           <td></td>
 111           <td class="md">)&nbsp;</td>
 112           <td class="md" colspan="2"></td>
 113         </tr>
 114
 115       </table>
 116     </td>
 117   </tr>
 118 </table>
 119 <table cellspacing=5 cellpadding=0 border=0>
 120   <tr>
 121     <td>
 122       &nbsp;
 123     </td>
 124     <td>
 125
 126 <p>
 127 Collect all pending events from the console's display. Plase these events on the server event queue using the <em>motion</em> and <em>enqueue</em> routines. The <em>checkspecial</em> routine is used to check for special keys that need handling. <em>block</em> tells if signals should be blocked when updating the event queue.     </td>
 128   </tr>
 129 </table>
 130 <a class="anchor" name="a0" doxytag="dmxconsole.h::dmxConsoleCreatePrivate" ></a><p>
 131 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 132   <tr>
 133     <td class="mdRow">
 134       <table cellpadding="0" cellspacing="0" border="0">
 135         <tr>
 136           <td class="md" nowrap valign="top"> pointer dmxConsoleCreatePrivate </td>
 137           <td class="md" valign="top">(&nbsp;</td>
 138           <td class="md" nowrap valign="top">DeviceIntPtr&nbsp;</td>
 139           <td class="mdname1" valign="top" nowrap> <em>pDevice</em>          </td>
 140           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 141           <td class="md" nowrap></td>
 142         </tr>
 143
 144       </table>
 145     </td>
 146   </tr>
 147 </table>
 148 <table cellspacing=5 cellpadding=0 border=0>
 149   <tr>
 150     <td>
 151       &nbsp;
 152     </td>
 153     <td>
 154
 155 <p>
 156 Create the private area for <em>pDevice</em>.     </td>
 157   </tr>
 158 </table>
 159 <a class="anchor" name="a1" doxytag="dmxconsole.h::dmxConsoleDestroyPrivate" ></a><p>
 160 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 161   <tr>
 162     <td class="mdRow">
 163       <table cellpadding="0" cellspacing="0" border="0">
 164         <tr>
 165           <td class="md" nowrap valign="top"> void dmxConsoleDestroyPrivate </td>
 166           <td class="md" valign="top">(&nbsp;</td>
 167           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 168           <td class="mdname1" valign="top" nowrap> <em>private</em>          </td>
 169           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 170           <td class="md" nowrap></td>
 171         </tr>
 172
 173       </table>
 174     </td>
 175   </tr>
 176 </table>
 177 <table cellspacing=5 cellpadding=0 border=0>
 178   <tr>
 179     <td>
 180       &nbsp;
 181     </td>
 182     <td>
 183
 184 <p>
 185 If <em>private</em> is non-NULL, free its associated memory.     </td>
 186   </tr>
 187 </table>
 188 <a class="anchor" name="a7" doxytag="dmxconsole.h::dmxConsoleFunctions" ></a><p>
 189 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 190   <tr>
 191     <td class="mdRow">
 192       <table cellpadding="0" cellspacing="0" border="0">
 193         <tr>
 194           <td class="md" nowrap valign="top"> int dmxConsoleFunctions </td>
 195           <td class="md" valign="top">(&nbsp;</td>
 196           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 197           <td class="mdname" nowrap> <em>private</em>, </td>
 198         </tr>
 199         <tr>
 200           <td></td>
 201           <td></td>
 202           <td class="md" nowrap>DMXFunctionType&nbsp;</td>
 203           <td class="mdname" nowrap> <em>function</em></td>
 204         </tr>
 205         <tr>
 206           <td></td>
 207           <td class="md">)&nbsp;</td>
 208           <td class="md" colspan="2"></td>
 209         </tr>
 210
 211       </table>
 212     </td>
 213   </tr>
 214 </table>
 215 <table cellspacing=5 cellpadding=0 border=0>
 216   <tr>
 217     <td>
 218       &nbsp;
 219     </td>
 220     <td>
 221
 222 <p>
 223 Handle special console-only keys.     </td>
 224   </tr>
 225 </table>
 226 <a class="anchor" name="a2" doxytag="dmxconsole.h::dmxConsoleInit" ></a><p>
 227 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 228   <tr>
 229     <td class="mdRow">
 230       <table cellpadding="0" cellspacing="0" border="0">
 231         <tr>
 232           <td class="md" nowrap valign="top"> void dmxConsoleInit </td>
 233           <td class="md" valign="top">(&nbsp;</td>
 234           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 235           <td class="mdname1" valign="top" nowrap> <em>pDev</em>          </td>
 236           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 237           <td class="md" nowrap></td>
 238         </tr>
 239
 240       </table>
 241     </td>
 242   </tr>
 243 </table>
 244 <table cellspacing=5 cellpadding=0 border=0>
 245   <tr>
 246     <td>
 247       &nbsp;
 248     </td>
 249     <td>
 250
 251 <p>
 252 Initialized the console device described by <em>pDev</em>.     </td>
 253   </tr>
 254 </table>
 255 <a class="anchor" name="a5" doxytag="dmxconsole.h::dmxConsoleKbdGetInfo" ></a><p>
 256 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 257   <tr>
 258     <td class="mdRow">
 259       <table cellpadding="0" cellspacing="0" border="0">
 260         <tr>
 261           <td class="md" nowrap valign="top"> void dmxConsoleKbdGetInfo </td>
 262           <td class="md" valign="top">(&nbsp;</td>
 263           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 264           <td class="mdname" nowrap> <em>pDev</em>, </td>
 265         </tr>
 266         <tr>
 267           <td></td>
 268           <td></td>
 269           <td class="md" nowrap><a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a>&nbsp;</td>
 270           <td class="mdname" nowrap> <em>info</em></td>
 271         </tr>
 272         <tr>
 273           <td></td>
 274           <td class="md">)&nbsp;</td>
 275           <td class="md" colspan="2"></td>
 276         </tr>
 277
 278       </table>
 279     </td>
 280   </tr>
 281 </table>
 282 <table cellspacing=5 cellpadding=0 border=0>
 283   <tr>
 284     <td>
 285       &nbsp;
 286     </td>
 287     <td>
 288
 289 <p>
 290 Fill in the <em>info</em> structure for the specified <em>pDev</em>. Only used for keyboard.     </td>
 291   </tr>
 292 </table>
 293 <a class="anchor" name="a4" doxytag="dmxconsole.h::dmxConsoleMouGetInfo" ></a><p>
 294 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 295   <tr>
 296     <td class="mdRow">
 297       <table cellpadding="0" cellspacing="0" border="0">
 298         <tr>
 299           <td class="md" nowrap valign="top"> void dmxConsoleMouGetInfo </td>
 300           <td class="md" valign="top">(&nbsp;</td>
 301           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 302           <td class="mdname" nowrap> <em>pDev</em>, </td>
 303         </tr>
 304         <tr>
 305           <td></td>
 306           <td></td>
 307           <td class="md" nowrap><a class="el" href="struct__DMXLocalInitInfo.html">DMXLocalInitInfoPtr</a>&nbsp;</td>
 308           <td class="mdname" nowrap> <em>info</em></td>
 309         </tr>
 310         <tr>
 311           <td></td>
 312           <td class="md">)&nbsp;</td>
 313           <td class="md" colspan="2"></td>
 314         </tr>
 315
 316       </table>
 317     </td>
 318   </tr>
 319 </table>
 320 <table cellspacing=5 cellpadding=0 border=0>
 321   <tr>
 322     <td>
 323       &nbsp;
 324     </td>
 325     <td>
 326
 327 <p>
 328 Fill in the <em>info</em> structure for the specified <em>pDev</em>. Only used for pointers.     </td>
 329   </tr>
 330 </table>
 331 <a class="anchor" name="a3" doxytag="dmxconsole.h::dmxConsoleReInit" ></a><p>
 332 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 333   <tr>
 334     <td class="mdRow">
 335       <table cellpadding="0" cellspacing="0" border="0">
 336         <tr>
 337           <td class="md" nowrap valign="top"> void dmxConsoleReInit </td>
 338           <td class="md" valign="top">(&nbsp;</td>
 339           <td class="md" nowrap valign="top">DevicePtr&nbsp;</td>
 340           <td class="mdname1" valign="top" nowrap> <em>pDev</em>          </td>
 341           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 342           <td class="md" nowrap></td>
 343         </tr>
 344
 345       </table>
 346     </td>
 347   </tr>
 348 </table>
 349 <table cellspacing=5 cellpadding=0 border=0>
 350   <tr>
 351     <td>
 352       &nbsp;
 353     </td>
 354     <td>
 355
 356 <p>
 357 Re-initialized the console device described by <em>pDev</em> (after a reconfig).     </td>
 358   </tr>
 359 </table>
 360 <a class="anchor" name="a11" doxytag="dmxconsole.h::dmxConsoleUncapture" ></a><p>
 361 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 362   <tr>
 363     <td class="mdRow">
 364       <table cellpadding="0" cellspacing="0" border="0">
 365         <tr>
 366           <td class="md" nowrap valign="top"> void dmxConsoleUncapture </td>
 367           <td class="md" valign="top">(&nbsp;</td>
 368           <td class="md" nowrap valign="top"><a class="el" href="struct__DMXInputInfo.html">DMXInputInfo</a> *&nbsp;</td>
 369           <td class="mdname1" valign="top" nowrap> <em>dmxInput</em>          </td>
 370           <td class="md" valign="top">&nbsp;)&nbsp;</td>
 371           <td class="md" nowrap></td>
 372         </tr>
 373
 374       </table>
 375     </td>
 376   </tr>
 377 </table>
 378 <table cellspacing=5 cellpadding=0 border=0>
 379   <tr>
 380     <td>
 381       &nbsp;
 382     </td>
 383     <td>
 384
 385 <p>
 386 Undo the capture that was done by <a class="el" href="dmxconsole_8h.html#a10">dmxConsoleCapture</a>.     </td>
 387   </tr>
 388 </table>
 389 <a class="anchor" name="a12" doxytag="dmxconsole.h::dmxConsoleUpdateInfo" ></a><p>
 390 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 391   <tr>
 392     <td class="mdRow">
 393       <table cellpadding="0" cellspacing="0" border="0">
 394         <tr>
 395           <td class="md" nowrap valign="top"> void dmxConsoleUpdateInfo </td>
 396           <td class="md" valign="top">(&nbsp;</td>
 397           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 398           <td class="mdname" nowrap> <em>private</em>, </td>
 399         </tr>
 400         <tr>
 401           <td></td>
 402           <td></td>
 403           <td class="md" nowrap><a class="el" href="dmxinput_8h.html#a30">DMXUpdateType</a>&nbsp;</td>
 404           <td class="mdname" nowrap> <em>type</em>, </td>
 405         </tr>
 406         <tr>
 407           <td></td>
 408           <td></td>
 409           <td class="md" nowrap>WindowPtr&nbsp;</td>
 410           <td class="mdname" nowrap> <em>pWindow</em></td>
 411         </tr>
 412         <tr>
 413           <td></td>
 414           <td class="md">)&nbsp;</td>
 415           <td class="md" colspan="2"></td>
 416         </tr>
 417
 418       </table>
 419     </td>
 420   </tr>
 421 </table>
 422 <table cellspacing=5 cellpadding=0 border=0>
 423   <tr>
 424     <td>
 425       &nbsp;
 426     </td>
 427     <td>
 428
 429 <p>
 430 Whenever the window layout (size, position, stacking order) might be changed, this routine is called with the <em>pWindow</em> that changed and the <em>type</em> of change. This routine is called in a conservative fashion: the actual layout of the windows of the screen might not have had any human-visible changes.     </td>
 431   </tr>
 432 </table>
 433 <a class="anchor" name="a8" doxytag="dmxconsole.h::dmxConsoleUpdatePosition" ></a><p>
 434 <table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
 435   <tr>
 436     <td class="mdRow">
 437       <table cellpadding="0" cellspacing="0" border="0">
 438         <tr>
 439           <td class="md" nowrap valign="top"> void dmxConsoleUpdatePosition </td>
 440           <td class="md" valign="top">(&nbsp;</td>
 441           <td class="md" nowrap valign="top">pointer&nbsp;</td>
 442           <td class="mdname" nowrap> <em>private</em>, </td>
 443         </tr>
 444         <tr>
 445           <td></td>
 446           <td></td>
 447           <td class="md" nowrap>int&nbsp;</td>
 448           <td class="mdname" nowrap> <em>x</em>, </td>
 449         </tr>
 450         <tr>
 451           <td></td>
 452           <td></td>
 453           <td class="md" nowrap>int&nbsp;</td>
 454           <td class="mdname" nowrap> <em>y</em></td>
 455         </tr>
 456         <tr>
 457           <td></td>
 458           <td class="md">)&nbsp;</td>
 459           <td class="md" colspan="2"></td>
 460         </tr>
 461
 462       </table>
 463     </td>
 464   </tr>
 465 </table>
 466 <table cellspacing=5 cellpadding=0 border=0>
 467   <tr>
 468     <td>
 469       &nbsp;
 470     </td>
 471     <td>
 472
 473 <p>
 474 This routine gets called from #dmxCoreMotion for each motion. This allows the console's notion of the cursor postion to change when another input device actually caused the change.     </td>
 475   </tr>
 476 </table>
 477     <hr>
 478     <address>
 479       <small>
 480         Generated June 29, 2004 for <a
 481         href="http://dmx.sourceforge.net">Distributed Multihead X</a> by
 482         <a href="http://www.doxygen.org/index.html">doxygen</a>
 483         1.3.4.
 484       </small>
 485     </addres>
 486     </hr>
 487   </body>
 488 </html>