File: Poco.XML.EventTarget.html

package info (click to toggle)
poco-doc 1.3.6-1
  • links: PTS
  • area: main
  • in suites: buster, jessie, jessie-kfreebsd, squeeze, stretch, wheezy
  • size: 10,076 kB
  • ctags: 9,611
  • sloc: makefile: 31
file content (62 lines) | stat: -rw-r--r-- 8,505 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<!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::EventTarget</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 EventTarget</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> DOM<br />
<b>Header:</b> Poco/DOM/EventTarget.h</p>
<h2>Description</h2>
<div class="description">
<p>The <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> interface is implemented by all Nodes in an implementation which supports the DOM <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> Model. Therefore, this interface can be obtained by using binding-specific casting methods on an instance of the <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> interface. The interface allows registration and removal of EventListeners on an <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> and dispatch of events to that <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a>. </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.AbstractContainerNode.html" title="class Poco::XML::AbstractContainerNode">AbstractContainerNode</a>, <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a>, <a href="Poco.XML.AbstractNode.html" title="class Poco::XML::AbstractNode">AbstractNode</a>, <a href="Poco.XML.CDATASection.html" title="class Poco::XML::CDATASection">CDATASection</a>, <a href="Poco.XML.Comment.html" title="class Poco::XML::Comment">Comment</a>, <a href="Poco.XML.CharacterData.html" title="class Poco::XML::CharacterData">CharacterData</a>, <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a>, <a href="Poco.XML.DocumentType.html" title="class Poco::XML::DocumentType">DocumentType</a>, <a href="Poco.XML.DocumentFragment.html" title="class Poco::XML::DocumentFragment">DocumentFragment</a>, <a href="Poco.XML.Element.html" title="class Poco::XML::Element">Element</a>, <a href="Poco.XML.Entity.html" title="class Poco::XML::Entity">Entity</a>, <a href="Poco.XML.EntityReference.html" title="class Poco::XML::EntityReference">EntityReference</a>, <a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a>, <a href="Poco.XML.ProcessingInstruction.html" title="class Poco::XML::ProcessingInstruction">ProcessingInstruction</a>, <a href="Poco.XML.Notation.html" title="class Poco::XML::Notation">Notation</a>, <a href="Poco.XML.Text.html" title="class Poco::XML::Text">Text</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.EventTarget.html#18402" title="Poco::XML::EventTarget::addEventListener()">addEventListener</a>, <a href="Poco.XML.EventTarget.html#18410" title="Poco::XML::EventTarget::dispatchEvent()">dispatchEvent</a>, <a href="Poco.XML.EventTarget.html#18406" title="Poco::XML::EventTarget::removeEventListener()">removeEventListener</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>Destructor</h2>
<h3><a name="18412">~EventTarget</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">virtual ~<a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="18402">addEventListener</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual void addEventListener(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; type,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.EventListener.html" title="class Poco::XML::EventListener">EventListener</a> * listener,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool useCapture<br />) = 0;</p>
<div class="description">
<p>This method allows the registration of event listeners on  the event target. If an <a href="Poco.XML.EventListener.html" title="class Poco::XML::EventListener">EventListener</a> is added to an <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> while it is processing an event, it will not  be triggered by the current actions but may be triggered during a later stage of event flow, such as the bubbling phase. If multiple identical EventListeners are registered on the same  <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> with the same parameters the duplicate instances are  discarded. They do not cause the <a href="Poco.XML.EventListener.html" title="class Poco::XML::EventListener">EventListener</a> to be called twice and since they are discarded they do not need to be removed with the removeEventListener method. 	 </p>
</div>
<h3><a name="18410">dispatchEvent</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual bool dispatchEvent(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> * evt<br />) = 0;</p>
<div class="description">
<p>This method allows the dispatch of events into the implementations  event model. Events dispatched in this manner will have the same capturing and  bubbling behavior as events dispatched directly by the implementation. The target of the event is the <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> on  which dispatchEvent is called.  </p>
</div>
<h3><a name="18406">removeEventListener</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual void removeEventListener(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; type,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.EventListener.html" title="class Poco::XML::EventListener">EventListener</a> * listener,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool useCapture<br />) = 0;</p>
<div class="description">
<p>This method allows the removal of event listeners from the event  target. If an <a href="Poco.XML.EventListener.html" title="class Poco::XML::EventListener">EventListener</a> is removed from an <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> while it is  processing an event, it will not be triggered by the current actions.  EventListeners can never be invoked after being removed. Calling removeEventListener with arguments which do not identify  any currently registered <a href="Poco.XML.EventListener.html" title="class Poco::XML::EventListener">EventListener</a> on the <a href="Poco.XML.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> has no effect.  </p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright &copy; 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>

</div>
</body>
</html>