You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
884 lines
42 KiB
HTML
884 lines
42 KiB
HTML
2 years ago
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
||
|
|
<title>Otter: EventRouter Class Reference</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="resize.js"></script>
|
||
|
|
<script type="text/javascript" src="navtree.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(initResizable);
|
||
|
|
$(window).load(resizeHeight);
|
||
|
|
</script>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
||
|
|
</script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td id="projectlogo"><img alt="Logo" src="otterlogosmall.png"/></td>
|
||
|
|
<td style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">Otter
|
||
|
|
 <span id="projectnumber">0.9.8.91</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">2d Game Development Framework based on SFML.Net</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
</script>
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="namespaces.html"><span>Packages</span></a></li>
|
||
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li>
|
||
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||
|
|
<span class="left">
|
||
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
alt=""/>
|
||
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||
|
|
</span><span class="right">
|
||
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div id="navrow2" class="tabs2">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||
|
|
<li><a href="classes.html"><span>Class Index</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>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||
|
|
<div id="nav-tree">
|
||
|
|
<div id="nav-tree-contents">
|
||
|
|
<div id="nav-sync" class="sync"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
||
|
|
class="ui-resizable-handle">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function(){initNavTree('class_event_router.html','');});
|
||
|
|
</script>
|
||
|
|
<div id="doc-content">
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Properties</a></div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#nested-classes">Classes</a> |
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pub-static-methods">Static Public Member Functions</a> |
|
||
|
|
<a href="#pub-static-attribs">Static Public Attributes</a> |
|
||
|
|
<a href="class_event_router-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">EventRouter Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Class for broadcasting messages to subscribers. Clients of the <a class="el" href="class_event_router.html" title="Class for broadcasting messages to subscribers. Clients of the EventRouter register themselves by cal...">EventRouter</a> register themselves by calling Subscribe and passing in the even they are interested in along with a delegate to be called back when the event is received. Events are published via the Publish method which allows arbitrary data to be passed along with the event to be interpreted by the event receiver. Events do not have to be pre-defined.
|
||
|
|
<a href="class_event_router.html#details">More...</a></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
||
|
|
Classes</h2></td></tr>
|
||
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router_1_1_event.html">Event</a></td></tr>
|
||
|
|
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="class_event_router_1_1_event.html" title="Event data class, passed in to the subscriber whenever an event occours. ">Event</a> data class, passed in to the subscriber whenever an event occours. <a href="class_event_router_1_1_event.html#details">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||
|
|
Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a3ec6091a42a830c55e28fe5e2dc7c314"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3ec6091a42a830c55e28fe5e2dc7c314"></a>
|
||
|
|
delegate void </td><td class="memItemRight" valign="bottom"><b>Handler</b> (<a class="el" href="class_event_router_1_1_event.html">Event</a> e)</td></tr>
|
||
|
|
<tr class="separator:a3ec6091a42a830c55e28fe5e2dc7c314"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
|
||
|
|
Static Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:a8e6b8253c06a0e4362e732318cadd600"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#a8e6b8253c06a0e4362e732318cadd600">Subscribe</a> (Enum evt, Handler h, object owner=null)</td></tr>
|
||
|
|
<tr class="memdesc:a8e6b8253c06a0e4362e732318cadd600"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to the event specified by evt. Pass in a delegate to be called back when the even occurs. <a href="#a8e6b8253c06a0e4362e732318cadd600">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a8e6b8253c06a0e4362e732318cadd600"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aac836b51e19965d7957d40ca756b5cdf"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#aac836b51e19965d7957d40ca756b5cdf">Subscribe</a> (string id, Enum evt, Handler h, object owner=null)</td></tr>
|
||
|
|
<tr class="memdesc:aac836b51e19965d7957d40ca756b5cdf"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to the event specified by evt filtered by the specified id. Pass in a delegate to be called back when the even occurs. <a href="#aac836b51e19965d7957d40ca756b5cdf">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aac836b51e19965d7957d40ca756b5cdf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a60c337056a38f24a6ec1c413491d4125"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#a60c337056a38f24a6ec1c413491d4125">Subscribe</a> (string id, string evt, Handler h, object owner=null)</td></tr>
|
||
|
|
<tr class="memdesc:a60c337056a38f24a6ec1c413491d4125"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to the event specified by evt. Pass in a delegate to be called back when the even occurs. <a href="#a60c337056a38f24a6ec1c413491d4125">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a60c337056a38f24a6ec1c413491d4125"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae06eeee29b50a029b91e88a734257908"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#ae06eeee29b50a029b91e88a734257908">Subscribe</a> (string evt, Handler h, object owner=null)</td></tr>
|
||
|
|
<tr class="memdesc:ae06eeee29b50a029b91e88a734257908"><td class="mdescLeft"> </td><td class="mdescRight">Subscribe to the event specified by evt. Pass in a delegate to be called back when the even occurs. <a href="#ae06eeee29b50a029b91e88a734257908">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ae06eeee29b50a029b91e88a734257908"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8f9d19d5ebb2c6e0103a6285fcffa463"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#a8f9d19d5ebb2c6e0103a6285fcffa463">Unsubscribe</a> (string id, Enum evt, Handler h)</td></tr>
|
||
|
|
<tr class="memdesc:a8f9d19d5ebb2c6e0103a6285fcffa463"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe the specified delegate from the event. <a href="#a8f9d19d5ebb2c6e0103a6285fcffa463">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a8f9d19d5ebb2c6e0103a6285fcffa463"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afd74fcc54e486dd4c950a2061d313080"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#afd74fcc54e486dd4c950a2061d313080">Unsubscribe</a> (Enum evt, Handler h)</td></tr>
|
||
|
|
<tr class="memdesc:afd74fcc54e486dd4c950a2061d313080"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe the specified delegate from the event. <a href="#afd74fcc54e486dd4c950a2061d313080">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:afd74fcc54e486dd4c950a2061d313080"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a06f3e4b55294c4aa900fa127ee9476d5"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#a06f3e4b55294c4aa900fa127ee9476d5">Unsubscribe</a> (string evt, Handler h)</td></tr>
|
||
|
|
<tr class="memdesc:a06f3e4b55294c4aa900fa127ee9476d5"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe the specified delegate from the event. <a href="#a06f3e4b55294c4aa900fa127ee9476d5">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a06f3e4b55294c4aa900fa127ee9476d5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afeb88329c74050ff523f4b3bc7974baf"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#afeb88329c74050ff523f4b3bc7974baf">Unsubscribe</a> (string id, string evt, Handler h)</td></tr>
|
||
|
|
<tr class="memdesc:afeb88329c74050ff523f4b3bc7974baf"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe the specified delegate from the event. <a href="#afeb88329c74050ff523f4b3bc7974baf">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:afeb88329c74050ff523f4b3bc7974baf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a533ff97d7204a39d83c70e9fe13288ec"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#a533ff97d7204a39d83c70e9fe13288ec">Unsubscribe</a> (object owner)</td></tr>
|
||
|
|
<tr class="memdesc:a533ff97d7204a39d83c70e9fe13288ec"><td class="mdescLeft"> </td><td class="mdescRight">Unsubscribe to all events that were subscribed to by a specific owner object. <a href="#a533ff97d7204a39d83c70e9fe13288ec">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a533ff97d7204a39d83c70e9fe13288ec"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a43c9d476c338b1939490b1a8d0fff0c7"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#a43c9d476c338b1939490b1a8d0fff0c7">Publish</a> (string id, string evt, params object[] data)</td></tr>
|
||
|
|
<tr class="memdesc:a43c9d476c338b1939490b1a8d0fff0c7"><td class="mdescLeft"> </td><td class="mdescRight">Publish the specified event with extra data. <a href="#a43c9d476c338b1939490b1a8d0fff0c7">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a43c9d476c338b1939490b1a8d0fff0c7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3119a1d40f4b57572224396c3751382b"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#a3119a1d40f4b57572224396c3751382b">Publish</a> (string evt, params object[] data)</td></tr>
|
||
|
|
<tr class="memdesc:a3119a1d40f4b57572224396c3751382b"><td class="mdescLeft"> </td><td class="mdescRight">Publish the specified event with extra data. <a href="#a3119a1d40f4b57572224396c3751382b">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a3119a1d40f4b57572224396c3751382b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae064db09188a36d38c87f73eb85c2d46"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#ae064db09188a36d38c87f73eb85c2d46">Publish</a> (string id, Enum evt, params object[] data)</td></tr>
|
||
|
|
<tr class="memdesc:ae064db09188a36d38c87f73eb85c2d46"><td class="mdescLeft"> </td><td class="mdescRight">Publish the specified event with extra data. <a href="#ae064db09188a36d38c87f73eb85c2d46">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ae064db09188a36d38c87f73eb85c2d46"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0a7ec464dd92775829612169a6a484c6"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#a0a7ec464dd92775829612169a6a484c6">Publish</a> (Enum evt, params object[] data)</td></tr>
|
||
|
|
<tr class="memdesc:a0a7ec464dd92775829612169a6a484c6"><td class="mdescLeft"> </td><td class="mdescRight">Publish the specified event with extra data. <a href="#a0a7ec464dd92775829612169a6a484c6">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a0a7ec464dd92775829612169a6a484c6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a18e923995805fb20858f1809e7d3b4df"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a18e923995805fb20858f1809e7d3b4df"></a>
|
||
|
|
static void </td><td class="memItemRight" valign="bottom"><b>Queue</b> (string id, string evt, params object[] data)</td></tr>
|
||
|
|
<tr class="separator:a18e923995805fb20858f1809e7d3b4df"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acd6f64faf5eb005cc32e8e2418dde79f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acd6f64faf5eb005cc32e8e2418dde79f"></a>
|
||
|
|
static void </td><td class="memItemRight" valign="bottom"><b>Queue</b> (string evt, params object[] data)</td></tr>
|
||
|
|
<tr class="separator:acd6f64faf5eb005cc32e8e2418dde79f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad2ca5084020982cd50828bd2bcbe2dda"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2ca5084020982cd50828bd2bcbe2dda"></a>
|
||
|
|
static void </td><td class="memItemRight" valign="bottom"><b>Queue</b> (string id, Enum evt, params object[] data)</td></tr>
|
||
|
|
<tr class="separator:ad2ca5084020982cd50828bd2bcbe2dda"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a63ba5e2351a9e27580b0e27ebe5140f8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63ba5e2351a9e27580b0e27ebe5140f8"></a>
|
||
|
|
static void </td><td class="memItemRight" valign="bottom"><b>Queue</b> (Enum evt, params object[] data)</td></tr>
|
||
|
|
<tr class="separator:a63ba5e2351a9e27580b0e27ebe5140f8"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a58f1f5b9423c3e503ea2c7c508d6441e"><td class="memItemLeft" align="right" valign="top">static void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_event_router.html#a58f1f5b9423c3e503ea2c7c508d6441e">Clear</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a58f1f5b9423c3e503ea2c7c508d6441e"><td class="mdescLeft"> </td><td class="mdescRight">Clear all event subscribers, used primarily when switching or resetting a level. <a href="#a58f1f5b9423c3e503ea2c7c508d6441e">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a58f1f5b9423c3e503ea2c7c508d6441e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
|
||
|
|
Static Public Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:a87a134f647563480b9ba5ff6901c5a86"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a87a134f647563480b9ba5ff6901c5a86"></a>
|
||
|
|
static bool </td><td class="memItemRight" valign="bottom"><b>LogEvents</b> = false</td></tr>
|
||
|
|
<tr class="separator:a87a134f647563480b9ba5ff6901c5a86"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Class for broadcasting messages to subscribers. Clients of the <a class="el" href="class_event_router.html" title="Class for broadcasting messages to subscribers. Clients of the EventRouter register themselves by cal...">EventRouter</a> register themselves by calling Subscribe and passing in the even they are interested in along with a delegate to be called back when the event is received. Events are published via the Publish method which allows arbitrary data to be passed along with the event to be interpreted by the event receiver. Events do not have to be pre-defined. </p>
|
||
|
|
<pre class="fragment">Publish and Subscribe methods also have an optional id parameter which will filter the events
|
||
|
|
sent to just those that match the provided id. Subscribing to an event with no id will result
|
||
|
|
in receiving all events of the specified type.
|
||
|
|
</pre> <p>Example of a simple publish and subscribe class, not using any id filtering.</p>
|
||
|
|
<p>Sender.cs <code></code></p>
|
||
|
|
<p><code> public enum SenderEvent { Test }</code></p>
|
||
|
|
<p><code> public class Sender { public void Send() { <a class="el" href="class_event_router.html#a43c9d476c338b1939490b1a8d0fff0c7" title="Publish the specified event with extra data. ">EventRouter.Publish</a>(SenderEvent.Test, "Hello World"); } } </code></p>
|
||
|
|
<p>Receiver.cs <code></code></p>
|
||
|
|
<p><code> public class Receiver { public Receiver() { <a class="el" href="class_event_router.html#a8e6b8253c06a0e4362e732318cadd600" title="Subscribe to the event specified by evt. Pass in a delegate to be called back when the even occurs...">EventRouter.Subscribe</a>(SenderEvent.Test, OnSenderEvent); }</code></p>
|
||
|
|
<p><code> void OnSenderEvent(<a class="el" href="class_event_router_1_1_event.html" title="Event data class, passed in to the subscriber whenever an event occours. ">EventRouter.Event</a> evt) { if(evt.HasData) { Console.WriteLine("Received event: " + evt.Type + " with data: " + evt.GetData<string>(0)); } else { Console.WriteLine("Received event: " + evt.Type + " with no data"); } } } </code> </p>
|
||
|
|
<p>Example of a publish and subscribe using id's to filter specific messages.</p>
|
||
|
|
<p>Sender.cs <code></code></p>
|
||
|
|
<p><code> public enum SenderEvent { Test }</code></p>
|
||
|
|
<p><code> public class Sender { public void SendA() { <a class="el" href="class_event_router.html#a43c9d476c338b1939490b1a8d0fff0c7" title="Publish the specified event with extra data. ">EventRouter.Publish</a>("A", SenderEvent.Test); }</code></p>
|
||
|
|
<p><code> public void SendB() { <a class="el" href="class_event_router.html#a43c9d476c338b1939490b1a8d0fff0c7" title="Publish the specified event with extra data. ">EventRouter.Publish</a>("B", SenderEvent.Test); } } </code></p>
|
||
|
|
<p>Receiver.cs <code></code></p>
|
||
|
|
<p><code> public class Receiver { public Receiver() { <a class="el" href="class_event_router.html#a8e6b8253c06a0e4362e732318cadd600" title="Subscribe to the event specified by evt. Pass in a delegate to be called back when the even occurs...">EventRouter.Subscribe</a>("A", SenderEvent.Test, OnSenderEventA); <a class="el" href="class_event_router.html#a8e6b8253c06a0e4362e732318cadd600" title="Subscribe to the event specified by evt. Pass in a delegate to be called back when the even occurs...">EventRouter.Subscribe</a>("B", SenderEvent.Test, OnSenderEventB); }</code></p>
|
||
|
|
<p><code> void OnSenderEventA(<a class="el" href="class_event_router_1_1_event.html" title="Event data class, passed in to the subscriber whenever an event occours. ">EventRouter.Event</a> evt) { Console.WriteLine("Received SenderEvent.Test with id 'A'"); }</code></p>
|
||
|
|
<p><code> void OnSenderEventB(<a class="el" href="class_event_router_1_1_event.html" title="Event data class, passed in to the subscriber whenever an event occours. ">EventRouter.Event</a> evt) { Console.WriteLine("Received SenderEvent.Test with id 'B'"); } } </code> </p>
|
||
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a58f1f5b9423c3e503ea2c7c508d6441e"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Clear </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Clear all event subscribers, used primarily when switching or resetting a level. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a43c9d476c338b1939490b1a8d0fff0c7"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Publish </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>id</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">params object[] </td>
|
||
|
|
<td class="paramname"><em>data</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Publish the specified event with extra data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The string representing the object. <dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">evt</td><td>The string representing the event. </td></tr>
|
||
|
|
<tr><td class="paramname">data</td><td>An arbitrary params array of objects to be interpreted by the receiver of the event. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a3119a1d40f4b57572224396c3751382b"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Publish </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">params object[] </td>
|
||
|
|
<td class="paramname"><em>data</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Publish the specified event with extra data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">evt</td><td>The string representing the event. </td></tr>
|
||
|
|
<tr><td class="paramname">data</td><td>An arbitrary params array of objects to be interpreted by the receiver of the event. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ae064db09188a36d38c87f73eb85c2d46"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Publish </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>id</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">params object[] </td>
|
||
|
|
<td class="paramname"><em>data</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Publish the specified event with extra data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The string representing the object. <dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">evt</td><td>The event enumeration value. </td></tr>
|
||
|
|
<tr><td class="paramname">data</td><td>An arbitrary params array of objects to be interpreted by the receiver of the event. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a0a7ec464dd92775829612169a6a484c6"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Publish </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">params object[] </td>
|
||
|
|
<td class="paramname"><em>data</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Publish the specified event with extra data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">evt</td><td>The event enumeration value. </td></tr>
|
||
|
|
<tr><td class="paramname">data</td><td>An arbitrary params array of objects to be interpreted by the receiver of the event. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a8e6b8253c06a0e4362e732318cadd600"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Subscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Handler </td>
|
||
|
|
<td class="paramname"><em>h</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">object </td>
|
||
|
|
<td class="paramname"><em>owner</em> = <code>null</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Subscribe to the event specified by evt. Pass in a delegate to be called back when the even occurs. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">evt</td><td>The event enumeration value. </td></tr>
|
||
|
|
<tr><td class="paramname">h</td><td>The delegate to be called when the even occurs. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aac836b51e19965d7957d40ca756b5cdf"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Subscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>id</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Handler </td>
|
||
|
|
<td class="paramname"><em>h</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">object </td>
|
||
|
|
<td class="paramname"><em>owner</em> = <code>null</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Subscribe to the event specified by evt filtered by the specified id. Pass in a delegate to be called back when the even occurs. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The id of the event </td></tr>
|
||
|
|
<tr><td class="paramname">evt</td><td>The event enumeration value. </td></tr>
|
||
|
|
<tr><td class="paramname">h</td><td>The delegate to be called when the even occurs. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a60c337056a38f24a6ec1c413491d4125"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Subscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>id</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Handler </td>
|
||
|
|
<td class="paramname"><em>h</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">object </td>
|
||
|
|
<td class="paramname"><em>owner</em> = <code>null</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Subscribe to the event specified by evt. Pass in a delegate to be called back when the even occurs. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The string representing the id. </td></tr>
|
||
|
|
<tr><td class="paramname">evt</td><td>The string representing the event. </td></tr>
|
||
|
|
<tr><td class="paramname">h</td><td>The delegate to be called when the even occurs. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ae06eeee29b50a029b91e88a734257908"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Subscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Handler </td>
|
||
|
|
<td class="paramname"><em>h</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">object </td>
|
||
|
|
<td class="paramname"><em>owner</em> = <code>null</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Subscribe to the event specified by evt. Pass in a delegate to be called back when the even occurs. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">evt</td><td>The string representing the event. </td></tr>
|
||
|
|
<tr><td class="paramname">h</td><td>The delegate to be called when the even occurs. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a8f9d19d5ebb2c6e0103a6285fcffa463"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Unsubscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>id</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Handler </td>
|
||
|
|
<td class="paramname"><em>h</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Unsubscribe the specified delegate from the event. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The id of the event </td></tr>
|
||
|
|
<tr><td class="paramname">evt</td><td>The event enumeration value. </td></tr>
|
||
|
|
<tr><td class="paramname">h</td><td>The delegate to be removed from the event handlers. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="afd74fcc54e486dd4c950a2061d313080"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Unsubscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Handler </td>
|
||
|
|
<td class="paramname"><em>h</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Unsubscribe the specified delegate from the event. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">evt</td><td>The event enumeration value. </td></tr>
|
||
|
|
<tr><td class="paramname">h</td><td>The delegate to be removed from the event handlers. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a06f3e4b55294c4aa900fa127ee9476d5"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Unsubscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Handler </td>
|
||
|
|
<td class="paramname"><em>h</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Unsubscribe the specified delegate from the event. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">evt</td><td>The string representing the event. </td></tr>
|
||
|
|
<tr><td class="paramname">h</td><td>The delegate to be removed from the event handlers. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="afeb88329c74050ff523f4b3bc7974baf"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Unsubscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>id</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>evt</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">Handler </td>
|
||
|
|
<td class="paramname"><em>h</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Unsubscribe the specified delegate from the event. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">id</td><td>The string representing the id. </td></tr>
|
||
|
|
<tr><td class="paramname">evt</td><td>The string representing the event. </td></tr>
|
||
|
|
<tr><td class="paramname">h</td><td>The delegate to be removed from the event handlers. </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a533ff97d7204a39d83c70e9fe13288ec"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">static void EventRouter.Unsubscribe </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">object </td>
|
||
|
|
<td class="paramname"><em>owner</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">static</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Unsubscribe to all events that were subscribed to by a specific owner object. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">owner</td><td>The object that subscribed to the object.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>Otter/Utility/EventRouter.cs</li>
|
||
|
|
</ul>
|
||
|
|
</div><!-- contents -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="class_event_router.html">EventRouter</a></li>
|
||
|
|
<li class="footer">Generated on Thu May 12 2016 18:16:51 for Otter by
|
||
|
|
<a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|