<!-- saved from url=(0026)http://www.naturaldocs.org -->
<divid=Content><divclass="CClass"><divclass=CTopicid=MainTopic><h1class=CTitle><aname="mxEventObject"></a>mxEventObject</h1><divclass=CBody><p>The mxEventObject is a wrapper for all properties of a single event. Additionally, it also offers functions to consume the event and check if it was consumed as follows:</p><blockquote><preclass="prettyprint">evt.consume();
INV: evt.isConsumed() == true</pre></blockquote><!--START_ND_SUMMARY--><divclass=Summary><divclass=STitle>Summary</div><divclass=SBorder><tableborder=0cellspacing=0cellpadding=0class=STable><trclass="SMain"><tdclass=SEntry><ahref="#mxEventObject">mxEventObject</a></td><tdclass=SDescription>The mxEventObject is a wrapper for all properties of a single event. </td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxEventObject.Functions">Functions</a></td><tdclass=SDescription></td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxEventObject.mxEventObject"id=link1onMouseOver="ShowTip(event, 'tt1', 'link1')"onMouseOut="HideTip('tt1')">mxEventObject</a></td><tdclass=SDescription>Constructs a new event object with the specified name. </td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxEventObject.Variables">Variables</a></td><tdclass=SDescription></td></tr><trclass="SVariable SIndent2 SMarked"><tdclass=SEntry><ahref="#mxEventObject.name"id=link2onMouseOver="ShowTip(event, 'tt2', 'link2')"onMouseOut="HideTip('tt2')">name</a></td><tdclass=SDescription>Holds the name.</td></tr><trclass="SVariable SIndent2"><tdclass=SEntry><ahref="#mxEventObject.properties"id=link3onMouseOver="ShowTip(event, 'tt3', 'link3')"onMouseOut="HideTip('tt3')">properties</a></td><tdclass=SDescription>Holds the properties as an associative array.</td></tr><trclass="SVariable SIndent2 SMarked"><tdclass=SEntry><ahref="#mxEventObject.consumed"id=link4onMouseOver="ShowTip(event, 'tt4', 'link4')"onMouseOut="HideTip('tt4')">consumed</a></td><tdclass=SDescription>Holds the consumed state. </td></tr><trclass="SGroup SIndent1"><tdclass=SEntry><ahref="#mxEventObject.Functions">Functions</a></td><tdclass=SDescription></td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxEventObject.getName"id=link5onMouseOver="ShowTip(event, 'tt5', 'link5')"onMouseOut="HideTip('tt5')">getName</a></td><tdclass=SDescription>Returns <ahref="#mxEventObject.name"class=LVariableid=link6onMouseOver="ShowTip(event, 'tt2', 'link6')"onMouseOut="HideTip('tt2')">name</a>.</td></tr><trclass="SFunction SIndent2"><tdclass=SEntry><ahref="#mxEventObject.getProperties"id=link7onMouseOver="ShowTip(event, 'tt6', 'link7')"onMouseOut="HideTip('tt6')">getProperties</a></td><tdclass=SDescription>Returns <ahref="#mxEventObject.properties"class=LVariableid=link8onMouseOver="ShowTip(event, 'tt3', 'link8')"onMouseOut="HideTip('tt3')">properties</a>.</td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxEventObject.getProperty"id=link9onMouseOver="ShowTip(event, 'tt7', 'link9')"onMouseOut="HideTip('tt7')">getProperty</a></td><tdclass=SDescription>Returns the property for the given key.</td></tr><trclass="SFunction SIndent2"><tdclass=SEntry><ahref="#mxEventObject.isConsumed"id=link10onMouseOver="ShowTip(event, 'tt8', 'link10')"onMouseOut="HideTip('tt8')">isConsumed</a></td><tdclass=SDescription>Returns true if the event has been consumed.</td></tr><trclass="SFunction SIndent2 SMarked"><tdclass=SEntry><ahref="#mxEventObject.consume"id=link11onMouseOver="ShowTip(event, 'tt9', 'link11')"onMouseOut="HideTip('tt9')">consume</a></td><tdclass=SDescription>Consumes the event.</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxEventObject.mxEventObject"></a>mxEventObject</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>function mxEventObject(</td><tdclass=PParameternowrap>name</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Constructs a new event object with the specified name. An optional sequence of key, value pairs can be appended to define properties.</p><h4class=CHeading>Example</h4><blockquote><preclass="prettyprint">new mxEventObject("eventName", key1, val1, .., keyN, valN)</pre></blockquote></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxEventObject.name"></a>name</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.name</td></tr></table></blockquote><p>Holds the name.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxEventObject.properties"></a>properties</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.properties</td></tr></table></blockquote><p>Holds the properties as an associative array.</p></div></div></div>
<divclass="CVariable"><divclass=CTopic><h3class=CTitle><aname="mxEventObject.consumed"></a>consumed</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.consumed</td></tr></table></blockquote><p>Holds the consumed state. Default is false.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxEventObject.getProperty"></a>getProperty</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxEventObject.prototype.getProperty = function(</td><tdclass=PParameternowrap>key</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote><p>Returns the property for the given key.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxEventObject.isConsumed"></a>isConsumed</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.isConsumed = function()</td></tr></table></blockquote><p>Returns true if the event has been consumed.</p></div></div></div>
<divclass="CFunction"><divclass=CTopic><h3class=CTitle><aname="mxEventObject.consume"></a>consume</h3><divclass=CBody><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.consume = function()</td></tr></table></blockquote><p>Consumes the event.</p></div></div></div>
</div><!--Content-->
<divid=Footer><ahref="http://www.naturaldocs.org">Generated by Natural Docs</a></div><!--Footer-->
<divclass=CToolTipid="tt1"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>function mxEventObject(</td><tdclass=PParameternowrap>name</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote>Constructs a new event object with the specified name. </div></div><divclass=CToolTipid="tt2"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.name</td></tr></table></blockquote>Holds the name.</div></div><divclass=CToolTipid="tt3"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.properties</td></tr></table></blockquote>Holds the properties as an associative array.</div></div><divclass=CToolTipid="tt4"><divclass=CVariable><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.consumed</td></tr></table></blockquote>Holds the consumed state. </div></div><divclass=CToolTipid="tt5"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.getName = function()</td></tr></table></blockquote>Returns name.</div></div><divclass=CToolTipid="tt6"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.getProperties = function()</td></tr></table></blockquote>Returns properties.</div></div><divclass=CToolTipid="tt7"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td><tableborder=0cellspacing=0cellpadding=0><tr><tdclass=PBeforeParametersnowrap>mxEventObject.prototype.getProperty = function(</td><tdclass=PParameternowrap>key</td><tdclass=PAfterParametersnowrap>)</td></tr></table></td></tr></table></blockquote>Returns the property for the given key.</div></div><divclass=CToolTipid="tt8"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.isConsumed = function()</td></tr></table></blockquote>Returns true if the event has been consumed.</div></div><divclass=CToolTipid="tt9"><divclass=CFunction><blockquote><tableborder=0cellspacing=0cellpadding=0class="Prototype prettyprint"><tr><td>mxEventObject.prototype.consume = function()</td></tr></table></blockquote>Consumes the event.</div></div><!--END_ND_TOOLTIPS-->
