<!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> <title>Class Poco::XML::Event</title> <meta http-equiv="content-type" content="text/html; charset=utf-8"/> <meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="language" content="en"/> <meta name="date" content="2009-11-24"/> <meta name="generator" content="PocoDoc"/> <link rel="stylesheet" href="css/styles.css" type="text/css"/> </head> <body bgcolor="#ffffff" leftmargin="0" topmargin="0"> <div class="header"> <h1 class="namespace"><a href="Poco.XML.html" class="namespace">Poco::XML</a></h1> <h1 class="symbol">class Event</h1> </div> <div class="body"> <p> <b>Library:</b> XML<br /> <b>Package:</b> DOM<br /> <b>Header:</b> Poco/DOM/Event.h</p> <h2>Description</h2> <div class="description"> <p>The <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> interface is used to provide contextual information about an event to the handler processing the event. An object which implements the <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> interface is generally passed as the first parameter to an event handler. More specific context information is passed to event handlers by deriving additional interfaces from <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> which contain information directly relating to the type of event they accompany. These derived interfaces are also implemented by the object passed to the event listener. </p> </div> <h2>Inheritance</h2> <p><b>Direct Base Classes: </b><a href="Poco.XML.DOMObject.html" title="class Poco::XML::DOMObject">DOMObject</a></p> <p><b>All Base Classes: </b><a href="Poco.XML.DOMObject.html" title="class Poco::XML::DOMObject">DOMObject</a></p> <p><b>Known Derived Classes: </b><a href="Poco.XML.MutationEvent.html" title="class Poco::XML::MutationEvent">MutationEvent</a></p> <h2>Member Summary</h2> <p><b>Member Functions: </b><a href="Poco.XML.Event.html#18330" title="Poco::XML::Event::autoRelease()">autoRelease</a>, <a href="Poco.XML.Event.html#18321" title="Poco::XML::Event::bubbles()">bubbles</a>, <a href="Poco.XML.Event.html#18322" title="Poco::XML::Event::cancelable()">cancelable</a>, <a href="Poco.XML.Event.html#18319" title="Poco::XML::Event::currentTarget()">currentTarget</a>, <a href="Poco.XML.Event.html#18320" title="Poco::XML::Event::eventPhase()">eventPhase</a>, <a href="Poco.XML.Event.html#18326" title="Poco::XML::Event::initEvent()">initEvent</a>, <a href="Poco.XML.Event.html#18341" title="Poco::XML::Event::isCanceled()">isCanceled</a>, <a href="Poco.XML.Event.html#18342" title="Poco::XML::Event::isStopped()">isStopped</a>, <a href="Poco.XML.Event.html#18325" title="Poco::XML::Event::preventDefault()">preventDefault</a>, <a href="Poco.XML.Event.html#18345" title="Poco::XML::Event::setCurrentPhase()">setCurrentPhase</a>, <a href="Poco.XML.Event.html#18347" title="Poco::XML::Event::setCurrentTarget()">setCurrentTarget</a>, <a href="Poco.XML.Event.html#18343" title="Poco::XML::Event::setTarget()">setTarget</a>, <a href="Poco.XML.Event.html#18324" title="Poco::XML::Event::stopPropagation()">stopPropagation</a>, <a href="Poco.XML.Event.html#18318" title="Poco::XML::Event::target()">target</a>, <a href="Poco.XML.Event.html#18323" title="Poco::XML::Event::timeStamp()">timeStamp</a>, <a href="Poco.XML.Event.html#18317" title="Poco::XML::Event::type()">type</a></p> <p><b>Inherited Functions: </b><a href="Poco.XML.DOMObject.html#17883" title="Poco::XML::DOMObject::autoRelease()">autoRelease</a>, <a href="Poco.XML.DOMObject.html#17881" title="Poco::XML::DOMObject::duplicate()">duplicate</a>, <a href="Poco.XML.DOMObject.html#17882" title="Poco::XML::DOMObject::release()">release</a></p> <h2>Enumerations</h2> <h3><a name="18313">PhaseType</a></h3> <div class="description"> <p></p> </div> <p class="decl"><a name="18314">CAPTURING_PHASE</a> = 1</p> <div class="description"> <p>The event is currently being evaluated at the target <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a>. </p> </div> <p class="decl"><a name="18315">AT_TARGET</a> = 2</p> <div class="description"> <p>The current event phase is the bubbling phase. </p> </div> <p class="decl"><a name="18316">BUBBLING_PHASE</a> = 3</p> <div class="description"> <p>The current event phase is the capturing phase. </p> </div> <h2>Constructors</h2> <h3><a name="18331">Event</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a>(<br /> <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & type<br />);</p> <div class="description"> <p></p> </div> <h3><a name="18334">Event</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a>(<br /> <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument,<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & type,<br /> <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> * pTarget,<br /> bool canBubble,<br /> bool isCancelable<br />);</p> <div class="description"> <p></p> </div> <h2>Destructor</h2> <h3><a name="18340">~Event</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">~<a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a>();</p> <div class="description"> <p></p> </div> <h2>Member Functions</h2> <h3><a name="18330">autoRelease</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void autoRelease();</p> <div class="description"> <p></p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.XML.DOMObject.html#17883" title="Poco::XML::DOMObject::autoRelease()">Poco::XML::DOMObject::autoRelease()</a></p></div> <h3><a name="18321">bubbles</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">bool bubbles() const;</p> <div class="description"> <p>Used to indicate whether or not an event is a bubbling event. If the event can bubble the value is true, else the value is false. </p> </div> <h3><a name="18322">cancelable</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">bool cancelable() const;</p> <div class="description"> <p>Used to indicate whether or not an event can have its default action prevented. If the default action can be prevented the value is true, else the value is false. </p> </div> <h3><a name="18319">currentTarget</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> * currentTarget() const;</p> <div class="description"> <p>Used to indicate the <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> whose EventListeners are currently being processed. This is particularly useful during capturing and bubbling. </p> </div> <h3><a name="18320">eventPhase</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.Event.html#18313" title="enum Poco::XML::Event::PhaseType">PhaseType</a> eventPhase() const;</p> <div class="description"> <p>Used to indicate which phase of event flow is currently being evaluated. </p> </div> <h3><a name="18326">initEvent</a></h3> <p class="decl">void initEvent(<br /> const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & eventType,<br /> bool canBubble,<br /> bool isCancelable<br />);</p> <div class="description"> <p>The initEvent method is used to initialize the value of an <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> created through the <a href="Poco.XML.DocumentEvent.html" title="class Poco::XML::DocumentEvent">DocumentEvent</a> interface. This method may only be called before the <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> has been dispatched via the dispatchEvent method, though it may be called multiple times during that phase if necessary. If called multiple times the final invocation takes precedence. If called from a subclass of <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> interface only the values specified in the initEvent method are modified, all other attributes are left unchanged. </p> </div> <h3><a name="18325">preventDefault</a></h3> <p class="decl">void preventDefault();</p> <div class="description"> <p>If an event is cancelable, the preventDefault method is used to signify that the event is to be canceled, meaning any default action normally taken by the implementation as a result of the event will not occur. If, during any stage of event flow, the preventDefault method is called the event is canceled. <a href="Poco.Any.html" title="class Poco::Any">Any</a> default action associated with the event will not occur. Calling this method for a non-cancelable event has no effect. Once preventDefault has been called it will remain in effect throughout the remainder of the event's propagation. This method may be used during any stage of event flow. </p> </div> <h3><a name="18324">stopPropagation</a></h3> <p class="decl">void stopPropagation();</p> <div class="description"> <p>The stopPropagation method is used prevent further propagation of an event during event flow. If this method is called by any <a href="Poco.XML.EventListener.html" title="class Poco::XML::EventListener">EventListener</a> the event will cease propagating through the tree. The event will complete dispatch to all listeners on the current <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> before event flow stops. This method may be used during any stage of event flow. </p> </div> <h3><a name="18318">target</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> * target() const;</p> <div class="description"> <p>Used to indicate the <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> to which the event was originally dispatched. </p> </div> <h3><a name="18323">timeStamp</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.html#11358" title="Poco::UInt64">Poco::UInt64</a> timeStamp() const;</p> <div class="description"> <p>Used to specify the time (in milliseconds relative to the epoch) at which the event was created. Due to the fact that some systems may not provide this information the value of timeStamp may be not available for all events. When not available, a value of 0 will be returned. Examples of epoch time are the time of the system start or 0:0:0 UTC 1st January 1970. This implementation always returns 0. </p> </div> <h3><a name="18317">type</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> & type() const;</p> <div class="description"> <p>The name of the event (case-insensitive). The name must be an <a href="Poco.XML.html" title="namespace Poco::XML">XML</a> name. </p> </div> <h3><a name="18341">isCanceled</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">bool isCanceled() const;</p> <div class="description"> <p>returns true if and only if the event has been cancelled. </p> </div> <h3><a name="18342">isStopped</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">bool isStopped() const;</p> <div class="description"> <p>returns true if and only if propagation of the event has been stopped. </p> </div> <h3><a name="18345">setCurrentPhase</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void setCurrentPhase(<br /> <a href="Poco.XML.Event.html#18313" title="enum Poco::XML::Event::PhaseType">PhaseType</a> phase<br />);</p> <div class="description"> <p>sets the current phase </p> </div> <h3><a name="18347">setCurrentTarget</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void setCurrentTarget(<br /> <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> * pTarget<br />);</p> <div class="description"> <p>sets the current target </p> </div> <h3><a name="18343">setTarget</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void setTarget(<br /> <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> * pTarget<br />);</p> <div class="description"> <p>sets the target </p> </div> <p class="footer">POCO C++ Libraries 1.3.6-all<br /> Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p> </div> </body> </html>
