Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > bad97183153701b09df5fae1052b1c30 > files > 2642

crystalspace-doc-1.2.1-5mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csMouseEventData Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
 <tr height="59">
  <td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
  <td class="head"><h2>Public API Reference</h2></td>
 </tr>
 <tr height="11">
  <td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
 </tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
  <ul>
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
    <li><a href="modules.html"><span>Modules</span></a></li>
    <li><a href="namespaces.html"><span>Namespaces</span></a></li>
    <li class="current"><a href="classes.html"><span>Classes</span></a></li>
    <li><a href="files.html"><span>Files</span></a></li>
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
  </ul>
</div>
<div class="tabs">
  <ul>
    <li><a href="classes.html"><span>Alphabetical&nbsp;List</span></a></li>
    <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul>
</div>
<h1>csMouseEventData Struct Reference<br>
<small>
[<a class="el" href="group__event__handling.html">Event handling</a>]</small>
</h1><!-- doxytag: class="csMouseEventData" -->Structure that collects the data a mouse event carries.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="iutil_2event_8h-source.html">iutil/event.h</a>&gt;</code>
<p>

<p>
<a href="structcsMouseEventData-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsMouseEventData.html#8b69d78ec9a97cb699716bfe95cd8fd3">axes</a> [CS_MAX_MOUSE_AXES]</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mouse axis values.  <a href="#8b69d78ec9a97cb699716bfe95cd8fd3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsMouseEventData.html#735ab13d229dd1aec3d3a90e1ece132e">Button</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Button number.  <a href="#735ab13d229dd1aec3d3a90e1ece132e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsMouseEventData.html#b11831323ae26ad955ddcb5743884642">Modifiers</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Control key state.  <a href="#b11831323ae26ad955ddcb5743884642"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsMouseEventData.html#b93c2d133c4f8457c225a2c4e628e065">numAxes</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mouse axis count.  <a href="#b93c2d133c4f8457c225a2c4e628e065"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsMouseEventData.html#ab97c11206ef8f0b8c892ee61568446e">x</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mouse x (same as axes[0]).  <a href="#ab97c11206ef8f0b8c892ee61568446e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structcsMouseEventData.html#6ea19d243c7d724d558786cb838f82aa">y</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Mouse y (same as axes[1]).  <a href="#6ea19d243c7d724d558786cb838f82aa"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Structure that collects the data a mouse event carries. 
<p>
The event it self doesn't transfer the data in this structure; it is merely meant to pass around mouse event data in a compact way within client code without having to pass around the event itself. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classcsMouseEventHelper.html" title="Helper class to conveniently deal with mouse events.">csMouseEventHelper</a> </dd></dl>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00152">152</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>
<hr><h2>Member Data Documentation</h2>
<a class="anchor" name="8b69d78ec9a97cb699716bfe95cd8fd3"></a><!-- doxytag: member="csMouseEventData::axes" ref="8b69d78ec9a97cb699716bfe95cd8fd3" args="[CS_MAX_MOUSE_AXES]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> <a class="el" href="structcsMouseEventData.html#8b69d78ec9a97cb699716bfe95cd8fd3">csMouseEventData::axes</a>[CS_MAX_MOUSE_AXES]          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Mouse axis values. 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00159">159</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="735ab13d229dd1aec3d3a90e1ece132e"></a><!-- doxytag: member="csMouseEventData::Button" ref="735ab13d229dd1aec3d3a90e1ece132e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> <a class="el" href="structcsMouseEventData.html#735ab13d229dd1aec3d3a90e1ece132e">csMouseEventData::Button</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Button number. 
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__event__handling.html#g7854bad75e3944e68ab354eceebd8ef4" title="Constants for mouse buttons.">csMouseButton</a> </dd></dl>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00166">166</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="b11831323ae26ad955ddcb5743884642"></a><!-- doxytag: member="csMouseEventData::Modifiers" ref="b11831323ae26ad955ddcb5743884642" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__util.html#g1134b580f8da4de94ca6b1de4d37975e">uint32</a> <a class="el" href="structcsMouseEventData.html#b11831323ae26ad955ddcb5743884642">csMouseEventData::Modifiers</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Control key state. 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00168">168</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="b93c2d133c4f8457c225a2c4e628e065"></a><!-- doxytag: member="csMouseEventData::numAxes" ref="b93c2d133c4f8457c225a2c4e628e065" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> <a class="el" href="structcsMouseEventData.html#b93c2d133c4f8457c225a2c4e628e065">csMouseEventData::numAxes</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Mouse axis count. 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00161">161</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="ab97c11206ef8f0b8c892ee61568446e"></a><!-- doxytag: member="csMouseEventData::x" ref="ab97c11206ef8f0b8c892ee61568446e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structcsMouseEventData.html#ab97c11206ef8f0b8c892ee61568446e">csMouseEventData::x</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Mouse x (same as axes[0]). 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00155">155</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="6ea19d243c7d724d558786cb838f82aa"></a><!-- doxytag: member="csMouseEventData::y" ref="6ea19d243c7d724d558786cb838f82aa" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structcsMouseEventData.html#6ea19d243c7d724d558786cb838f82aa">csMouseEventData::y</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Mouse y (same as axes[1]). 
<p>

<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00157">157</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>iutil/<a class="el" href="iutil_2event_8h-source.html">event.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by 
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3 
</small></address> </div></body> </html>