home *** CD-ROM | disk | FTP | other *** search
/ RISCWORLD 7 / RISCWORLD_VOL7.iso / Software / Issue4 / SDL / gcc346 / !SDL / man / SDL_KeyboardEvent.3 < prev    next >
Encoding:
Text File  |  2006-09-20  |  2.2 KB  |  72 lines
  1. <!-- manual page source format generated by PolyglotMan v3.0.8+X.Org, -->
  2. <!-- available at http://polyglotman.sourceforge.net/ -->
  3.  
  4. <html>
  5. <head>
  6. <title>"SDL_KeyboardEvent"("3") manual page</title>
  7. </head>
  8. <body bgcolor='#efefef' text='black' link='blue' vlink='#551A8B' alink='red'>
  9. <a href='#toc'>Table of Contents</a><p>
  10.  
  11. <h2><a name='sect0' href='#toc0'>Name</a></h2>
  12. SDL_KeyboardEvent- Keyboard event structure 
  13. <h2><a name='sect1' href='#toc1'>Structure Definition</a></h2>
  14. <p>
  15. <br>
  16. <pre>CWtypedef struct{
  17.   Uint8 type;
  18.   Uint8 state;
  19.   SDL_keysym keysym;
  20. } SDL_KeyboardEvent;
  21. </pre><p>
  22.  
  23. <h2><a name='sect2' href='#toc2'>Structure Data</a></h2>
  24.  
  25. <dl>
  26.  
  27. <dt><b>type</b> </dt>
  28. <dd><b>SDL_KEYDOWN</b> or <b>SDL_KEYUP</b> </dd>
  29.  
  30. <dt><b>state</b> </dt>
  31. <dd><b>SDL_PRESSED</b> or <b>SDL_RELEASED</b>
  32. </dd>
  33.  
  34. <dt><b>keysym</b> </dt>
  35. <dd>Contains key press information </dd>
  36. </dl>
  37.  
  38. <h2><a name='sect3' href='#toc3'>Description</a></h2>
  39. <p>
  40. <b>SDL_KeyboardEvent</b> is a
  41. member of the <i><b>SDL_Event</b></i> union and is used when an event of type <b>SDL_KEYDOWN</b>
  42. or <b>SDL_KEYUP</b> is reported. <p>
  43. The <b>type</b> and <b>state</b> actually report the same information,
  44. they just use different values to do it! A keyboard event occurs when a
  45. key is released (<b>type</b>=<b>SDK_KEYUP</b> or <b>state</b>=<b>SDL_RELEASED</b>) and when a key is
  46. pressed (<b>type</b>=<b>SDL_KEYDOWN</b> or <b>state</b>=<b>SDL_PRESSED</b>). The information on what
  47. key was pressed or released is in the <i><b>keysym</b></i> structure. <p>
  48. <blockquote><b>Note:   <p>
  49. Repeating
  50. <b>SDL_KEYDOWN</b></b> events will occur if key repeat is enabled (see <i><b>SDL_EnableKeyRepeat</b></i>).
  51. </blockquote>
  52.  
  53. <h2><a name='sect4' href='#toc4'>See Also</a></h2>
  54. <p>
  55. <i><b>SDL_Event</b></i>, <i><b>SDL_keysym</b></i>, <i><b>SDL_EnableKeyRepeat</b></i>, <i><b>SDL_EnableUNICODE</b></i> 
  56. <!--
  57.   
  58.  
  59. <p>
  60.  
  61. <hr><p>
  62. <a name='toc'><b>Table of Contents</b></a><p>
  63. <ul>
  64. <li><a name='toc0' href='#sect0'>Name</a></li>
  65. <li><a name='toc1' href='#sect1'>Structure Definition</a></li>
  66. <li><a name='toc2' href='#sect2'>Structure Data</a></li>
  67. <li><a name='toc3' href='#sect3'>Description</a></li>
  68. <li><a name='toc4' href='#sect4'>See Also</a></li>
  69. </ul>
  70. </body>
  71. </html>
  72.