<!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: csEventOutlet Class 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>csEventOutlet Class Reference</h1><!-- doxytag: class="csEventOutlet" --><!-- doxytag: inherits="scfImplementation1< csEventOutlet, iEventOutlet >" -->A class which implements the <a class="el" href="structiEventOutlet.html" title="The iEventOutlet is the interface to an object that is provided by an event queue...">iEventOutlet</a> interface.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="evoutlet_8h-source.html">csutil/evoutlet.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csEventOutlet:</div>
<div class="dynsection">
<p><center><img src="classcsEventOutlet__inherit__graph.png" border="0" usemap="#csEventOutlet__inherit__map" alt="Inheritance graph"></center>
<map name="csEventOutlet__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csEventOutlet, iEventOutlet \>" alt="" coords="60,161,420,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csEventOutlet \>" alt="" coords="5,84,269,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="293,7,349,33"><area shape="rect" href="structiEventOutlet.html" title="The iEventOutlet is the interface to an object that is provided by an event queue..." alt="" coords="293,84,395,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="27,7,248,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsEventOutlet-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 void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventOutlet.html#655ced810b8b0575e56e588edc4c7d95">Broadcast</a> (<a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> iName, <a class="el" href="group__util.html#g0fbe4a4f8dd857ee04923a901f27465f">intptr_t</a> iInfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a broadcast event into event queue. <a href="#655ced810b8b0575e56e588edc4c7d95"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a>< <a class="el" href="structiEvent.html">iEvent</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventOutlet.html#74905ba88ca23165b3676a2e02031b6a">CreateEvent</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a event object on behalf of the system driver. <a href="#74905ba88ca23165b3676a2e02031b6a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventOutlet.html#6e80cd0d71bb7366620c033dd08b5d15">csEventOutlet</a> (<a class="el" href="structiEventPlug.html">iEventPlug</a> *, <a class="el" href="classcsEventQueue.html">csEventQueue</a> *, <a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Initialize the outlet. <a href="#6e80cd0d71bb7366620c033dd08b5d15"></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="classcsEventOutlet.html#212c14a097d034f4c5790c1c638c7f2e">ImmediateBroadcast</a> (<a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> iName, <a class="el" href="group__util.html#g0fbe4a4f8dd857ee04923a901f27465f">intptr_t</a> iInfo)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Broadcast a event to all plugins. <a href="#212c14a097d034f4c5790c1c638c7f2e"></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="classcsEventOutlet.html#c2dfda3b1e4e44bcf2a024fa0c8ea791">Joystick</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> iNumber, int iButton, bool iDown, const <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *axes, <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> numAxes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a joystick event into event queue. <a href="#c2dfda3b1e4e44bcf2a024fa0c8ea791"></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="classcsEventOutlet.html#4c6a0d18e41d4b473b382f331f3939f7">Key</a> (<a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> codeRaw, <a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> codeCooked, bool iDown, bool autorep=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a keyboard event into event queue. <a href="#4c6a0d18e41d4b473b382f331f3939f7"></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="classcsEventOutlet.html#728e5b2616a6a126baab6beaeee1ad43">Mouse</a> (<a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> iNumber, int iButton, bool iDown, const <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> *axes, <a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> numAxes)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a mouse event into event queue (new interface). <a href="#728e5b2616a6a126baab6beaeee1ad43"></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="classcsEventOutlet.html#c82d080802520644043806b39e5558e7">Mouse</a> (int iButton, bool iDown, int x, int y)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a mouse event into event queue (old interface). <a href="#c82d080802520644043806b39e5558e7"></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="classcsEventOutlet.html#6ebe91fea284f9f69ad4cb76e9ba0ddb">Post</a> (<a class="el" href="structiEvent.html">iEvent</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Put a previously created event into system event queue. <a href="#6ebe91fea284f9f69ad4cb76e9ba0ddb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsEventOutlet.html#601a1f1713bef643bd1031d886f0ba99">~csEventOutlet</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Destroy the outlet. <a href="#601a1f1713bef643bd1031d886f0ba99"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A class which implements the <a class="el" href="structiEventOutlet.html" title="The iEventOutlet is the interface to an object that is provided by an event queue...">iEventOutlet</a> interface.
<p>Definition at line <a class="el" href="evoutlet_8h-source.html#l00040">40</a> of file <a class="el" href="evoutlet_8h-source.html">evoutlet.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="6e80cd0d71bb7366620c033dd08b5d15"></a><!-- doxytag: member="csEventOutlet::csEventOutlet" ref="6e80cd0d71bb7366620c033dd08b5d15" args="(iEventPlug *, csEventQueue *, iObjectRegistry *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">csEventOutlet::csEventOutlet </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEventPlug.html">iEventPlug</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classcsEventQueue.html">csEventQueue</a> * </td>
<td class="paramname">, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="structiObjectRegistry.html">iObjectRegistry</a> * </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Initialize the outlet.
<p>
</div>
</div><p>
<a class="anchor" name="601a1f1713bef643bd1031d886f0ba99"></a><!-- doxytag: member="csEventOutlet::~csEventOutlet" ref="601a1f1713bef643bd1031d886f0ba99" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual csEventOutlet::~csEventOutlet </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Destroy the outlet.
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="655ced810b8b0575e56e588edc4c7d95"></a><!-- doxytag: member="csEventOutlet::Broadcast" ref="655ced810b8b0575e56e588edc4c7d95" args="(csEventID iName, intptr_t iInfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csEventOutlet::Broadcast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>iName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g0fbe4a4f8dd857ee04923a901f27465f">intptr_t</a> </td>
<td class="paramname"> <em>iInfo</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put a broadcast event into event queue.
<p>
<p>Implements <a class="el" href="structiEventOutlet.html#c5b91758afe5ca9f9c69f10c8a3a2bad">iEventOutlet</a>.</p>
</div>
</div><p>
<a class="anchor" name="74905ba88ca23165b3676a2e02031b6a"></a><!-- doxytag: member="csEventOutlet::CreateEvent" ref="74905ba88ca23165b3676a2e02031b6a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiEvent.html">iEvent</a>> csEventOutlet::CreateEvent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Create a event object on behalf of the system driver.
<p>
<p>Implements <a class="el" href="structiEventOutlet.html#61b7467d8965d83de5725e693f258324">iEventOutlet</a>.</p>
</div>
</div><p>
<a class="anchor" name="212c14a097d034f4c5790c1c638c7f2e"></a><!-- doxytag: member="csEventOutlet::ImmediateBroadcast" ref="212c14a097d034f4c5790c1c638c7f2e" args="(csEventID iName, intptr_t iInfo)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csEventOutlet::ImmediateBroadcast </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__event__handling.html#g51e1762faeeefdadf693499fc93db757">csEventID</a> </td>
<td class="paramname"> <em>iName</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g0fbe4a4f8dd857ee04923a901f27465f">intptr_t</a> </td>
<td class="paramname"> <em>iInfo</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Broadcast a event to all plugins.
<p>
<p>Implements <a class="el" href="structiEventOutlet.html#50f99d2fd2f1d8e8eccefa635758b1f9">iEventOutlet</a>.</p>
</div>
</div><p>
<a class="anchor" name="c2dfda3b1e4e44bcf2a024fa0c8ea791"></a><!-- doxytag: member="csEventOutlet::Joystick" ref="c2dfda3b1e4e44bcf2a024fa0c8ea791" args="(uint iNumber, int iButton, bool iDown, const int32 *axes, uint numAxes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csEventOutlet::Joystick </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>iNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>iButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>iDown</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> * </td>
<td class="paramname"> <em>axes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>numAxes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put a joystick event into event queue.
<p>
<p>Implements <a class="el" href="structiEventOutlet.html#fed7b62837a941ca0d2649d1e9e9b66b">iEventOutlet</a>.</p>
</div>
</div><p>
<a class="anchor" name="4c6a0d18e41d4b473b382f331f3939f7"></a><!-- doxytag: member="csEventOutlet::Key" ref="4c6a0d18e41d4b473b382f331f3939f7" args="(utf32_char codeRaw, utf32_char codeCooked, bool iDown, bool autorep=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csEventOutlet::Key </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> </td>
<td class="paramname"> <em>codeRaw</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g47e911f87ff568b2779f26cf226f5070">utf32_char</a> </td>
<td class="paramname"> <em>codeCooked</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>iDown</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>autorep</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put a keyboard event into event queue.
<p>
<p>Implements <a class="el" href="structiEventOutlet.html#8e3348ffe402594d043ad4e4fd0454d7">iEventOutlet</a>.</p>
</div>
</div><p>
<a class="anchor" name="728e5b2616a6a126baab6beaeee1ad43"></a><!-- doxytag: member="csEventOutlet::Mouse" ref="728e5b2616a6a126baab6beaeee1ad43" args="(uint iNumber, int iButton, bool iDown, const int32 *axes, uint numAxes)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csEventOutlet::Mouse </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>iNumber</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>iButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>iDown</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="group__util.html#g56f1a81c92849566ae864511088eb7e8">int32</a> * </td>
<td class="paramname"> <em>axes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14">uint</a> </td>
<td class="paramname"> <em>numAxes</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put a mouse event into event queue (new interface).
<p>
</div>
</div><p>
<a class="anchor" name="c82d080802520644043806b39e5558e7"></a><!-- doxytag: member="csEventOutlet::Mouse" ref="c82d080802520644043806b39e5558e7" args="(int iButton, bool iDown, int x, int y)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csEventOutlet::Mouse </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>iButton</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>iDown</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>x</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>y</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put a mouse event into event queue (old interface).
<p>
<p>Implements <a class="el" href="structiEventOutlet.html#4998a2b765ff1a411817358d154bb317">iEventOutlet</a>.</p>
</div>
</div><p>
<a class="anchor" name="6ebe91fea284f9f69ad4cb76e9ba0ddb"></a><!-- doxytag: member="csEventOutlet::Post" ref="6ebe91fea284f9f69ad4cb76e9ba0ddb" args="(iEvent *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csEventOutlet::Post </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiEvent.html">iEvent</a> * </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Put a previously created event into system event queue.
<p>
<p>Implements <a class="el" href="structiEventOutlet.html#ce0c4dfa15d7737811ae2e3e495b02c7">iEventOutlet</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="evoutlet_8h-source.html">evoutlet.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
>
470
