Sophie

Sophie

distrib > Mageia > 6 > i586 > media > core-release > by-pkgid > c6769e2011cd0bbbaff4458281ce4746 > files > 49

libSDLmm-devel-0.1.8-5.mga6.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>SDLmm::EventHandler class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; </center>
<hr><h1>SDLmm::EventHandler  Class Reference</h1>The base class used for custom <a class="el" href="classSDLmm_1_1Event.html">Event</a> handlers. 
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="sdlmm__eventhandler_8h-source.html">sdlmm_eventhandler.h</a>&gt;</code>
<p>
<a href="classSDLmm_1_1EventHandler-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a> (SDL_Event &amp;event)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Catch-all event handler.</em> <a href="#a18">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Keyboard Events</div></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a0">HandleKeyboardEvent</a> (SDL_keysym &amp;keysym, bool pressed)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Keyboard event callback.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a1">HandleKeyPressEvent</a> (SDL_keysym &amp;keysym)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Keyboard press event callback.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a2">HandleKeyReleaseEvent</a> (SDL_keysym &amp;keysym)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Keyboard release event callback.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Mouse Events</div></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a3">HandleMouseMotionEvent</a> (Uint8 state, Uint16 x, Uint16 y, Sint16 xrel, Sint16 yrel)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Mouse motion event callback.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a4">HandleMouseButtonEvent</a> (Uint8 button, Uint16 x, Uint16 y, bool pressed)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Mouse button event callback.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a5">HandleMouseButtonPressEvent</a> (Uint8 button, Uint16 x, Uint16 y)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Mouse button press event callback.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a6">HandleMouseButtonReleaseEvent</a> (Uint8 button, Uint16 x, Uint16 y)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Mouse button release event callback.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Joystick Events</div></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a7">HandleJoyAxisEvent</a> (Uint8 joystick, Uint8 axis, Sint16 value)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> axis motion event callback.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a8">HandleJoyButtonEvent</a> (Uint8 joystick, Uint8 button, bool pressed)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> button event callback.</em> <a href="#a8">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a9">HandleJoyButtonPressEvent</a> (Uint8 joystick, Uint8 button)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> button press event callback.</em> <a href="#a9">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a10">HandleJoyButtonReleaseEvent</a> (Uint8 joystick, Uint8 button)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> button release event callback.</em> <a href="#a10">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a11">HandleJoyHatEvent</a> (Uint8 joystick, Uint8 hat, Uint8 value)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> hat position change event callback.</em> <a href="#a11">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a12">HandleJoyBallEvent</a> (Uint8 joystick, Uint8 ball, Sint16 xrel, Sint16 yrel)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em><a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> trackball motion event callback.</em> <a href="#a12">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Window / Display Events</div></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a13">HandleActiveEvent</a> (bool gain, Uint8 state)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Application visibility event callback.</em> <a href="#a13">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a14">HandleResizeEvent</a> (int w, int h)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Window resize event callback.</em> <a href="#a14">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a15">HandleSysWMEvent</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Platform-dependent window manager event callback.</em> <a href="#a15">More...</a><em></em></font><br><br></td></tr>
<tr><td colspan="2"><div class="groupHeader">Other Events</div></td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a16">HandleUserEvent</a> (Uint8 type, int code, void *data1, void *data2)</td></tr>
<tr><td nowrap align=right valign=top>virtual bool&nbsp;</td><td valign=bottom><a class="el" href="classSDLmm_1_1EventHandler.html#a17">HandleQuitEvent</a> ()</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Quit requested event callback.</em> <a href="#a17">More...</a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The base class used for custom <a class="el" href="classSDLmm_1_1Event.html">Event</a> handlers.
<p>
The event handling in <a class="el" href="namespace__SDLmm.html">SDLmm</a> is rather different to that of SDL in  that it uses classes derived from the <a class="el" href="classSDLmm_1_1EventHandler.html">EventHandler</a>. This allows for clean, type-safe code much closer to the spirit of C++ than the use of a union with a type field. To handle one or more events, you simply build a class derived from this, reimplementing the only functions for the events you need to handle. <dl compact><dt>
<b>See also: </b><dd>
<a class="el" href="classSDLmm_1_1Event.html#d4">Event::HandleEvents</a>() </dl>
<p>
<hr><h2>Member Function Documentation</h2>
<a name="a13" doxytag="SDLmm::EventHandler::HandleActiveEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleActiveEvent (
          </b></td>
          <td valign="bottom"><b>
bool <em>gain</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint8 <em>state</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Application visibility event callback.
<p>
This callback is called when an event of type SDL_ACTIVEEVENT is reported.
<p>
When the mouse leaves or enters the window area a SDL_APPMOUSEFOCUS type activation event occurs, if the mouse entered the window then <em>gain</em> will be true, otherwise <em>gain</em> will be false. A SDL_APPINPUTFOCUS type activation event occurs when the application loses or gains keyboard focus. This usually occurs when another application is made active. Finally, a SDL_APPACTIVE <em>type</em> event occurs when the application is either minimised/iconified (<em>gain=false)</em> or restored.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>gain</em>
&nbsp;</td><td>
false if the event is a loss or true if it's a gain </td></tr>
<tr><td valign=top><em>state</em>
&nbsp;</td><td>
SDL_APPMOUSEFOCUS if mouse focus was gained or lost, SDL_APPINPUTFOCUS if input focus was gained or lost, or SDL_APPACTIVE if the application was iconified (gain=false) or restored (gain=true)
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a18" doxytag="SDLmm::EventHandler::HandleEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleEvent (
          </b></td>
          <td valign="bottom"><b>
SDL_Event &amp; <em>event</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Catch-all event handler.
<p>
This method is called if none of the event specific callbacks handled event (i.e they returned false).
<p>
<dl compact><dt>
<b>Note: </b><dd>
It's both easier and more efficient to use the event-specific callbacks, so unless you really want to do all the work yourself, you want to use those.</dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>event</em>
&nbsp;</td><td>
the current event
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not </dl>    </td>
  </tr>
</table>
<a name="a7" doxytag="SDLmm::EventHandler::HandleJoyAxisEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleJoyAxisEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>joystick</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint8 <em>axis</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Sint16 <em>value</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> axis motion event callback.
<p>
This is used when an event of type SDL_JOYAXISMOTION is reported.
<p>
A SDL_JOYAXISMOTION event occurs when ever a user moves an axis on the joystick. <dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>joystick</em>
&nbsp;</td><td>
the index of the joystick that reported the event </td></tr>
<tr><td valign=top><em>axis</em>
&nbsp;</td><td>
the index of the axis (for a more detailed explaination see the <a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> section of the SDL manual).  </td></tr>
</table>
</dl><dl compact><dt>
<b>ams value is the current position of the axis.</b><dd>
 </dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a12" doxytag="SDLmm::EventHandler::HandleJoyBallEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleJoyBallEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>joystick</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint8 <em>ball</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Sint16 <em>xrel</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Sint16 <em>yrel</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> trackball motion event callback.
<p>
Thyis is used when an event of type SDL_JOYBALLMOTION is reported.
<p>
A SDL_JOYBALLMOTION event occurs when a user moves a trackball on the joystick. The field <em>joystick</em> is the index of the joystick that reported the event and <em>ball</em> is the index of the trackball (for a more detailed explaination see the <a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> section in the SDL documentation). Trackballs only return relative motion, this is the change in position on the ball since it was last polled (last cycle of the event loop) and it is stored in <em>xrel</em> and <em>yrel</em>.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>joystick</em>
&nbsp;</td><td>
joystick device index </td></tr>
<tr><td valign=top><em>ball</em>
&nbsp;</td><td>
joystick trackbal index </td></tr>
<tr><td valign=top><em>xrel, yrel</em>
&nbsp;</td><td>
relative motion in the x/y directions
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a8" doxytag="SDLmm::EventHandler::HandleJoyButtonEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleJoyButtonEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>joystick</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint8 <em>button</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
bool <em>pressed</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> button event callback.
<p>
This is used when an event of type SDL_JOYBUTTONDOWN or SDL_JOYBUTTONUP is reported.
<p>
These events occurs when ever a user presses or releases a button on a joystick.
<p>
<dl compact><dt>
<b>Note: </b><dd>
This function is only called if the default <a class="el" href="classSDLmm_1_1EventHandler.html#a9">HandleJoyButtonPressEvent</a>() and / or <a class="el" href="classSDLmm_1_1EventHandler.html#a10">HandleJoyButtonReleaseEvent</a>() methods are used.</dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>joystick</em>
&nbsp;</td><td>
the index of the joystick that reported the event </td></tr>
<tr><td valign=top><em>button</em>
&nbsp;</td><td>
the index of the pressed button (for a more detailed explaination see the <a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> section of the SDL manual). </td></tr>
<tr><td valign=top><em>pressed</em>
&nbsp;</td><td>
true for SDL_JOYBUTTONDOWN, false for SDL_JOYBUTTONUP.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a9" doxytag="SDLmm::EventHandler::HandleJoyButtonPressEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleJoyButtonPressEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>joystick</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint8 <em>button</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> button press event callback.
<p>
This is used when an event of type SDL_JOYBUTTONDOWN is reported.
<p>
A SDL_JOYBUTTONDOWN event occurs when ever a user presses a button on a joystick.
<p>
<dl compact><dt>
<b>Note: </b><dd>
The default declaration of this method calls the <a class="el" href="classSDLmm_1_1EventHandler.html#a8">HandleJoyButtonEvent</a>() method. If you want to handle both button presses and releases in the same method, just redefine <a class="el" href="classSDLmm_1_1EventHandler.html#a8">HandleJoyButtonEvent</a>().</dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>joystick</em>
&nbsp;</td><td>
the index of the joystick that reported the event </td></tr>
<tr><td valign=top><em>button</em>
&nbsp;</td><td>
the index of the pressed button (for a more detailed explaination see the <a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> section of the SDL manual).
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a10" doxytag="SDLmm::EventHandler::HandleJoyButtonReleaseEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleJoyButtonReleaseEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>joystick</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint8 <em>button</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> button release event callback.
<p>
This is used when an event of type SDL_JOYBUTTONUP is reported.
<p>
A SDL_JOYBUTTONUP event occurs when ever a user releases a button on a joystick.
<p>
<dl compact><dt>
<b>Note: </b><dd>
The default declaration of this method calls the <a class="el" href="classSDLmm_1_1EventHandler.html#a8">HandleJoyButtonEvent</a>() method. If you want to handle both button presses and releases in the same method, just redefine <a class="el" href="classSDLmm_1_1EventHandler.html#a8">HandleJoyButtonEvent</a>().</dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>joystick</em>
&nbsp;</td><td>
the index of the joystick that reported the event </td></tr>
<tr><td valign=top><em>button</em>
&nbsp;</td><td>
the index of the released button (for a more detailed explaination see the <a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> section of the SDL manual).
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a11" doxytag="SDLmm::EventHandler::HandleJoyHatEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleJoyHatEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>joystick</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint8 <em>hat</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint8 <em>value</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
<a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> hat position change event callback.
<p>
This is used when an event of type SDL_JOYHATMOTION is reported.
<p>
A SDL_JOYHATMOTION event occurs when ever a user moves a hat on the joystick. The field <em>joystick</em> is the index of the joystick that reported the event and <em>hat</em> is the index of the hat (for a more detailed exlaination see the <a class="el" href="classSDLmm_1_1Joystick.html">Joystick</a> section in the SDL documentation). <em>value</em> is the current position of the hat. It is a logically OR'd combination of the following values (whose meanings should be pretty obvious):<ul>
<li>SDL_HAT_CENTERED<li>SDL_HAT_UP<li>SDL_HAT_RIGHT<li>SDL_HAT_DOWN<li>SDL_HAT_LEFT</ul>
The following defines are also provided:
<p>
<ul>
<li>SDL_HAT_RIGHTUP<li>SDL_HAT_RIGHTDOWN<li>SDL_HAT_LEFTUP<li>SDL_HAT_LEFTDOWN</ul>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>joystick</em>
&nbsp;</td><td>
joystick device index </td></tr>
<tr><td valign=top><em>hat</em>
&nbsp;</td><td>
joystick hat index </td></tr>
<tr><td valign=top><em>value</em>
&nbsp;</td><td>
hat position
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a1" doxytag="SDLmm::EventHandler::HandleKeyPressEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleKeyPressEvent (
          </b></td>
          <td valign="bottom"><b>
SDL_keysym &amp; <em>keysym</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Keyboard press event callback.
<p>
This callback is used when an event of type SDL_KEYDOWN is reported. A keyboard press event occurs when a key is pressed.
<p>
<dl compact><dt>
<b>Note: </b><dd>
Repeating SDL_KEYDOWN events will occur if key repeat is enabled (see EnableKeyRepeat()). <dd>
The default declaration of this method calls the <a class="el" href="classSDLmm_1_1EventHandler.html#a0">HandleKeyboardEvent</a>() method. If you want to handle both key presses and key releases in the same method, just redefine <a class="el" href="classSDLmm_1_1EventHandler.html#a0">HandleKeyboardEvent</a>().  </dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keysym</em>
&nbsp;</td><td>
information about the pressed key
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a2" doxytag="SDLmm::EventHandler::HandleKeyReleaseEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleKeyReleaseEvent (
          </b></td>
          <td valign="bottom"><b>
SDL_keysym &amp; <em>keysym</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Keyboard release event callback.
<p>
This callback is used when an event of type SDL_KEYUP is reported. A keyboard press event occurs when a key is released.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keysym</em>
&nbsp;</td><td>
the information about the released key </td></tr>
</table>
</dl><dl compact><dt>
<b>Note: </b><dd>
The default declaration of this method calls the <a class="el" href="classSDLmm_1_1EventHandler.html#a0">HandleKeyboardEvent</a>() method. If you want to handle both key presses and releases in the same method, just redefine <a class="el" href="classSDLmm_1_1EventHandler.html#a0">HandleKeyboardEvent</a>().
<p>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a0" doxytag="SDLmm::EventHandler::HandleKeyboardEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleKeyboardEvent (
          </b></td>
          <td valign="bottom"><b>
SDL_keysym &amp; <em>keysym</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
bool <em>pressed</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Keyboard event callback.
<p>
This callback is used when an event of type SDL_KEYDOWN or SDL_KEYUP is reported. These occur when keys are pressed or released.
<p>
<dl compact><dt>
<b>Note: </b><dd>
Repeating SDL_KEYDOWN events will occur if key repeat is enabled (see EnableKeyRepeat()). <dd>
This function is only called if the default <a class="el" href="classSDLmm_1_1EventHandler.html#a1">HandleKeyPressEvent</a>() and / or <a class="el" href="classSDLmm_1_1EventHandler.html#a2">HandleKeyReleaseEvent</a>() methods are used.  </dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>keysym</em>
&nbsp;</td><td>
information about the pressed key </td></tr>
<tr><td valign=top><em>pressed</em>
&nbsp;</td><td>
true for SDL_KEYDOWN, false for SDL_KEYUP
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a4" doxytag="SDLmm::EventHandler::HandleMouseButtonEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleMouseButtonEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>button</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint16 <em>x</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint16 <em>y</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
bool <em>pressed</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Mouse button event callback.
<p>
This is used when an event of type SDL_MOUSEBUTTONDOWN or SDL_MOUSEBUTTONUP is reported.
<p>
When a mouse button press is detected the number of the button pressed (from 1 to 255, with 1 usually being the left button and 2 the right) is placed into <em>button</em>. The position of the mouse when this event occured is stored in <em>x</em> and <em>y</em>.
<p>
<dl compact><dt>
<b>Note: </b><dd>
This function is only called if the default <a class="el" href="classSDLmm_1_1EventHandler.html#a5">HandleMouseButtonPressEvent</a>() and / or <a class="el" href="classSDLmm_1_1EventHandler.html#a6">HandleMouseButtonReleaseEvent</a>() methods are used.</dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>button</em>
&nbsp;</td><td>
the mouse button index </td></tr>
<tr><td valign=top><em>x, y</em>
&nbsp;</td><td>
the x/y coordinates of the mouse at press time </td></tr>
<tr><td valign=top><em>pressed</em>
&nbsp;</td><td>
true for SDL_MOUSEBUTTONDOWN, false for SDL_MOUSEBUTTONUP.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a5" doxytag="SDLmm::EventHandler::HandleMouseButtonPressEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleMouseButtonPressEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>button</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint16 <em>x</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint16 <em>y</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Mouse button press event callback.
<p>
This is used when an event of type SDL_MOUSEBUTTONDOWN is reported.
<p>
When a mouse button press is detected the number of the button pressed (from 1 to 255, with 1 usually being the left button and 2 the right) is placed into <em>button</em>. The position of the mouse when this event occured is stored in <em>x</em> and <em>y</em>.
<p>
<dl compact><dt>
<b>Note: </b><dd>
The default declaration of this method calls the <a class="el" href="classSDLmm_1_1EventHandler.html#a4">HandleMouseButtonEvent</a>() method. If you want to handle both button presses and releases in the same method, just redefine <a class="el" href="classSDLmm_1_1EventHandler.html#a4">HandleMouseButtonEvent</a>().</dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>button</em>
&nbsp;</td><td>
the mouse button index </td></tr>
<tr><td valign=top><em>x, y</em>
&nbsp;</td><td>
the x/y coordinates of the mouse at press time
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a6" doxytag="SDLmm::EventHandler::HandleMouseButtonReleaseEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleMouseButtonReleaseEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>button</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint16 <em>x</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint16 <em>y</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Mouse button release event callback.
<p>
This is used when an event of type SDL_MOUSEBUTTONUP is reported.
<p>
When a mouse button release is detected the number of the button release (from 1 to 255, with 1 usually being the left button and 2 the right) is placed into <em>button</em>. The position of the mouse when this event occured is stored in <em>x</em> and <em>y</em>.
<p>
<dl compact><dt>
<b>Note: </b><dd>
The default declaration of this method calls the <a class="el" href="classSDLmm_1_1EventHandler.html#a4">HandleMouseButtonEvent</a>() method. If you want to handle both button presses and releases in the same method, just redefine <a class="el" href="classSDLmm_1_1EventHandler.html#a4">HandleMouseButtonEvent</a>().</dl><dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>button</em>
&nbsp;</td><td>
the mouse button index </td></tr>
<tr><td valign=top><em>x, y</em>
&nbsp;</td><td>
the x/y coordinates of the mouse at press time
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a3" doxytag="SDLmm::EventHandler::HandleMouseMotionEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleMouseMotionEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>state</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint16 <em>x</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Uint16 <em>y</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Sint16 <em>xrel</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
Sint16 <em>yrel</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Mouse motion event callback.
<p>
This is used when an event of type SDL_MOUSEMOTION is reported.
<p>
Simply put, a SDL_MOUSEMOTION type event occurs when a user moves the mouse within the application window or when SDL_WarpMouse is called. Both the absolute (<em>x</em> and <em>y)</em> and relative (<em>xrel</em> and <em>yrel)</em> coordinates are reported along with the current button states (<em>state)</em>. The button <em>state</em> can be interpreted using the SDL_BUTTON macro (see GetMouseState()).
<p>
If the cursor is hidden (Display::HideCursor()) and the input is grabbed (Display::GrabInput(SDL_GRAB_ON)) then the mouse will give relative motion events even when the cursor reaches the edge of the screen. This is currently only implemented on Windows and Linux/Unix-a-likes.<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>state</em>
&nbsp;</td><td>
the current button state. </td></tr>
<tr><td valign=top><em>x, y</em>
&nbsp;</td><td>
the absolute x/y coordinates of the mouse pointer </td></tr>
<tr><td valign=top><em>xrel, yrel</em>
&nbsp;</td><td>
relative motion in the x/y directions
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a17" doxytag="SDLmm::EventHandler::HandleQuitEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleQuitEvent (
          </b></td>
          <td valign="bottom"><b>
)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Quit requested event callback.
<p>
This is used whan an event of type SDL_QUIT is reported.
<p>
The SDL_QUIT event is very important. If you filter out or ignore a quit event it is impossible for the user to close the window. On the other hand, if you do accept a quit event, the application window will be closed, and screen updates will still report success, even though the application will no longer be visible.
<p>
<dl compact><dt>
<b>Note: </b><dd>
The macro SDL_QuitRequested will return non-zero if a quit event is pending.
<p>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a14" doxytag="SDLmm::EventHandler::HandleResizeEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleResizeEvent (
          </b></td>
          <td valign="bottom"><b>
int <em>w</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
int <em>h</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Window resize event callback.
<p>
This is used when an event of type SDL_VIDEORESIZE is reported.
<p>
When SDL_RESIZABLE is passed as a flag to <a class="el" href="classSDLmm_1_1Display.html#a6">Display::SetVideoMode</a>() the user is allowed to resize the applications window. When the window is resized an SDL_VIDEORESIZE is reported, with the new window width and height values stored in <em>w</em> and <em>h</em>, respectively. When an SDL_VIDEORESIZE is recieved the window should be resized to the new dimensions using <a class="el" href="classSDLmm_1_1Display.html#a6">Display::SetVideoMode</a>();<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>w, h</em>
&nbsp;</td><td>
new width and height of the window.
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a15" doxytag="SDLmm::EventHandler::HandleSysWMEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleSysWMEvent (
          </b></td>
          <td valign="bottom"><b>
)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Platform-dependent window manager event callback.
<p>
The system window manager event contains a pointer to system-specific information about unknown window manager events. If you enable this event using <a class="el" href="classSDLmm_1_1Event.html#d3">Event::EventState</a>(), it will be generated whenever unhandled events are received from the window manager. This can be used, for example, to implement cut-and-paste in your application.
<p>
If you want to obtain system-specific information about the window manager, you can fill the version member of a SDL_SysWMinfo structure (details can be found in SDL_syswm.h, which must be included) using the SDL_VERSION() macro found in SDL_version.h, and pass it to the function:
<p>
<div class="fragment"><pre>      <font class="keywordtype">int</font> SDL_GetWMInfo(SDL_SysWMinfo *info);</pre></div>
<p>
<dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<a name="a16" doxytag="SDLmm::EventHandler::HandleUserEvent"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
  <tr>
    <td class="md">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td nowrap valign="top"><b> 
bool SDLmm::EventHandler::HandleUserEvent (
          </b></td>
          <td valign="bottom"><b>
Uint8 <em>type</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
int <em>code</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
void * <em>data1</em>, 
          </b></td>
        </tr>
        <tr>
          <td></td>
          <td><b>
void * <em>data2</em>&nbsp;)<code> [inline, virtual]</code>
          </b></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
This event is unique - it is never created by SDL but only by the user. The event can be pushed onto the event queue using <a class="el" href="classSDLmm_1_1Event.html#a2">Event::Push</a>(). The contents of <em>data1</em> and <em>data2</em> are completely up to the programmer. The only requirement is that <em>type</em> is a value from SDL_USEREVENT to SDL_NUMEVENTS-1 (inclusive).<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>type</em>
&nbsp;</td><td>
SDL_USEREVENT through to SDL_NUMEVENTS-1 </td></tr>
<tr><td valign=top><em>code</em>
&nbsp;</td><td>
user defined event code </td></tr>
<tr><td valign=top><em>data1, data2</em>
&nbsp;</td><td>
user defined data pointers
<p>
</td></tr>
</table>
</dl><dl compact><dt>
<b>Returns: </b><dd>
true if the event was handled, false if it was not. If the event wasn't handled, it will be handed over to the generic <a class="el" href="classSDLmm_1_1EventHandler.html#a18">HandleEvent</a>() method. </dl>    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="sdlmm__eventhandler_8h-source.html">sdlmm_eventhandler.h</a></ul>
<hr>
<table cellspacing=10 cellpadding=0 border=0 width=100%>
<tr valign=middle><td><font size=-1>Documentation automatically generated by <a
href="http://www.stack.nl/~dimitri/doxygen/"><img border=0 align=center src="doxygen.gif" alt="doxygen"></a> written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>.</font></td>
<td align=right><font size=-1>Project hosted at <br><a href="http://sourceforge.net"><img align=middle src="http://sourceforge.net/sflogo.php?group_id=25445&type=1" width="88" height="31" border="0"  alt="Hosted by SourceForge"></a></font></td></tr></table>