<!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: iEventCord 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 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 Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iEventCord Struct Reference<br>
<small>
[<a class="el" href="group__event__handling.html">Event handling</a>]</small>
</h1><!-- doxytag: class="iEventCord" --><!-- doxytag: inherits="iBase" -->The <a class="el" href="structiEventCord.html" title="The iEventCord is an interface provided by an event queue to any event handlers wanting...">iEventCord</a> is an interface provided by an event queue to any event handlers wanting to receive some subclasses of events ASAP in a specified priority, bypassing the queue itself.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="iutil_2event_8h-source.html">iutil/event.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iEventCord:</div>
<div class="dynsection">
<p><center><img src="structiEventCord__inherit__graph.png" border="0" usemap="#iEventCord__inherit__map" alt="Inheritance graph"></center>
<map name="iEventCord__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csEventCord, iEventCord \>" alt="" coords="5,161,349,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="149,7,205,33"><area shape="rect" href="classcsEventCord.html" title="Event cord." alt="" coords="125,239,229,265"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiEventCord-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventCord.html#9bd70bb36b0a2d2c344f18966c5505f4">GetName</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the category of this cord. <a href="#9bd70bb36b0a2d2c344f18966c5505f4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventCord.html#81576bf562f2d4bc97c4964cae9738ae">GetPass</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if events are passed on to the owning event queue if all plugins in the cord return false from HandleEvent(). <a href="#81576bf562f2d4bc97c4964cae9738ae"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventCord.html#d9b80ee319756877bc8f191310a84ca4">Insert</a> (<a class="el" href="structiEventHandler.html">iEventHandler</a> *, int priority)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Insert an event handler into the cord. <a href="#d9b80ee319756877bc8f191310a84ca4"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventCord.html#d502185aaa91ee5cb0904006e9d0ec7a">Remove</a> (<a class="el" href="structiEventHandler.html">iEventHandler</a> *)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Remove an event handler from the cord. <a href="#d502185aaa91ee5cb0904006e9d0ec7a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiEventCord.html#c8b1125f36dc5e5e518d56d82eea0699">SetPass</a> (bool)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Sets whether events are passed along to the owning event queue if all plugins in the cord return false from HandleEvent(). <a href="#c8b1125f36dc5e5e518d56d82eea0699"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The <a class="el" href="structiEventCord.html" title="The iEventCord is an interface provided by an event queue to any event handlers wanting...">iEventCord</a> is an interface provided by an event queue to any event handlers wanting to receive some subclasses of events ASAP in a specified priority, bypassing the queue itself.
<p>
Events may also optionally be sent to the normal event queue itself if none of the event handlers in the cord handle the event.
<p>Definition at line <a class="el" href="iutil_2event_8h-source.html#l00538">538</a> of file <a class="el" href="iutil_2event_8h-source.html">event.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="9bd70bb36b0a2d2c344f18966c5505f4"></a><!-- doxytag: member="iEventCord::GetName" ref="9bd70bb36b0a2d2c344f18966c5505f4" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> iEventCord::GetName </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the category of this cord.
<p>
<p>Implemented in <a class="el" href="classcsEventCord.html#2758ff7252a1026ee4e5f71149b3b357">csEventCord</a>.</p>
</div>
</div><p>
<a class="anchor" name="81576bf562f2d4bc97c4964cae9738ae"></a><!-- doxytag: member="iEventCord::GetPass" ref="81576bf562f2d4bc97c4964cae9738ae" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool iEventCord::GetPass </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Returns true if events are passed on to the owning event queue if all plugins in the cord return false from HandleEvent().
<p>
<p>Implemented in <a class="el" href="classcsEventCord.html#f463343c4c1c448a478a78d346a4d299">csEventCord</a>.</p>
</div>
</div><p>
<a class="anchor" name="d9b80ee319756877bc8f191310a84ca4"></a><!-- doxytag: member="iEventCord::Insert" ref="d9b80ee319756877bc8f191310a84ca4" args="(iEventHandler *, int priority)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iEventCord::Insert </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEventHandler.html">iEventHandler</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>priority</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Insert an event handler into the cord.
<p>
The priority defines when it will receive the event with respect to other registered event handlers. Event handlers with the same priority are handled in a first-come first-served fashion. This is significant since returning true from HandleEvent() will stop further event processing.
<p>Implemented in <a class="el" href="classcsEventCord.html#dd13d785acfb5e949a93640b0bc3b802">csEventCord</a>.</p>
</div>
</div><p>
<a class="anchor" name="d502185aaa91ee5cb0904006e9d0ec7a"></a><!-- doxytag: member="iEventCord::Remove" ref="d502185aaa91ee5cb0904006e9d0ec7a" args="(iEventHandler *)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iEventCord::Remove </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEventHandler.html">iEventHandler</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Remove an event handler from the cord.
<p>
<p>Implemented in <a class="el" href="classcsEventCord.html#2f68822ca8bd4392a045fcbf388fd1f8">csEventCord</a>.</p>
</div>
</div><p>
<a class="anchor" name="c8b1125f36dc5e5e518d56d82eea0699"></a><!-- doxytag: member="iEventCord::SetPass" ref="c8b1125f36dc5e5e518d56d82eea0699" args="(bool)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iEventCord::SetPass </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets whether events are passed along to the owning event queue if all plugins in the cord return false from HandleEvent().
<p>
<p>Implemented in <a class="el" href="classcsEventCord.html#fda1234510fca4c05b997e30ad5caec2">csEventCord</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>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
2985
