File: Poco.XML.MutationEvent.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 (145 lines) | stat: -rw-r--r-- 16,667 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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
<!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::MutationEvent</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 MutationEvent</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> DOM<br />
<b>Header:</b> Poco/DOM/MutationEvent.h</p>
<h2>Description</h2>
<div class="description">
<p>The <a href="Poco.XML.MutationEvent.html" title="class Poco::XML::MutationEvent">MutationEvent</a> interface provides specific contextual  information associated with Mutation events. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a></p>
<p><b>All Base Classes: </b><a href="Poco.XML.DOMObject.html" title="class Poco::XML::DOMObject">DOMObject</a>, <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.MutationEvent.html#18422" title="Poco::XML::MutationEvent::attrChange()">attrChange</a>, <a href="Poco.XML.MutationEvent.html#18421" title="Poco::XML::MutationEvent::attrName()">attrName</a>, <a href="Poco.XML.MutationEvent.html#18423" title="Poco::XML::MutationEvent::initMutationEvent()">initMutationEvent</a>, <a href="Poco.XML.MutationEvent.html#18420" title="Poco::XML::MutationEvent::newValue()">newValue</a>, <a href="Poco.XML.MutationEvent.html#18419" title="Poco::XML::MutationEvent::prevValue()">prevValue</a>, <a href="Poco.XML.MutationEvent.html#18418" title="Poco::XML::MutationEvent::relatedNode()">relatedNode</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.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.DOMObject.html#17881" title="Poco::XML::DOMObject::duplicate()">duplicate</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.DOMObject.html#17882" title="Poco::XML::DOMObject::release()">release</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>
<h2>Enumerations</h2>
<h3><a name="18414">AttrChangeType</a></h3>
<div class="description">
<p></p>
</div>
<p class="decl"><a name="18415">MODIFICATION</a> = 1</p>
<div class="description">
<p>The <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> was modified in place. </p>
</div>
<p class="decl"><a name="18416">ADDITION</a> = 2</p>
<div class="description">
<p>The <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> was just added.  </p>
</div>
<p class="decl"><a name="18417">REMOVAL</a> = 3</p>
<div class="description">
<p>The <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> was just removed.  </p>
</div>
<h2>Constructors</h2>
<h3><a name="18439">MutationEvent</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.MutationEvent.html" title="class Poco::XML::MutationEvent">MutationEvent</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; type<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="18442">MutationEvent</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.MutationEvent.html" title="class Poco::XML::MutationEvent">MutationEvent</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument,<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.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> * pTarget,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool canBubble,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool cancelable,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * relatedNode<br />);</p>
<div class="description">
<p></p>
</div>
<h3><a name="18449">MutationEvent</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.MutationEvent.html" title="class Poco::XML::MutationEvent">MutationEvent</a>(<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> * pOwnerDocument,<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.EventTarget.html" title="class Poco::XML::EventTarget">EventTarget</a> * pTarget,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool canBubble,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool cancelable,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * relatedNode,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; prevValue,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; newValue,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; attrName,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.MutationEvent.html#18414" title="enum  Poco::XML::MutationEvent::AttrChangeType">AttrChangeType</a> change<br />);</p>
<div class="description">
<p></p>
</div>
<h2>Destructor</h2>
<h3><a name="18460">~MutationEvent</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.MutationEvent.html" title="class Poco::XML::MutationEvent">MutationEvent</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="18422">attrChange</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.MutationEvent.html#18414" title="enum  Poco::XML::MutationEvent::AttrChangeType">AttrChangeType</a> attrChange() const;</p>
<div class="description">
<p>attrChange indicates the type of change which triggered the  <a href="Poco.XML.MutationEvent.html#18437" title="Poco::XML::MutationEvent::DOMAttrModified">DOMAttrModified</a> event. The values can be <a href="Poco.XML.MutationEvent.html#18415" title="Poco::XML::MutationEvent::MODIFICATION">MODIFICATION</a>, <a href="Poco.XML.MutationEvent.html#18416" title="Poco::XML::MutationEvent::ADDITION">ADDITION</a>, or <a href="Poco.XML.MutationEvent.html#18417" title="Poco::XML::MutationEvent::REMOVAL">REMOVAL</a>. </p>
</div>
<h3><a name="18421">attrName</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> &amp; attrName() const;</p>
<div class="description">
<p>attrName indicates the name of the changed <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> node in a <a href="Poco.XML.MutationEvent.html#18437" title="Poco::XML::MutationEvent::DOMAttrModified">DOMAttrModified</a> event. </p>
</div>
<h3><a name="18423">initMutationEvent</a></h3>
<p class="decl">void initMutationEvent(<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;bool canBubble,<br />&nbsp;&nbsp;&nbsp;&nbsp;bool cancelable,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * relatedNode,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; prevValue,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; newValue,<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; attrName,<br />&nbsp;&nbsp;&nbsp;&nbsp;<a href="Poco.XML.MutationEvent.html#18414" title="enum  Poco::XML::MutationEvent::AttrChangeType">AttrChangeType</a> change<br />);</p>
<div class="description">
<p>The initMutationEvent method is used to initialize the value of a  <a href="Poco.XML.MutationEvent.html" title="class Poco::XML::MutationEvent">MutationEvent</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.MutationEvent.html" title="class Poco::XML::MutationEvent">MutationEvent</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. </p>
</div>
<h3><a name="18420">newValue</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> &amp; newValue() const;</p>
<div class="description">
<p>newValue indicates the new value of the <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> node in <a href="Poco.XML.MutationEvent.html#18437" title="Poco::XML::MutationEvent::DOMAttrModified">DOMAttrModified</a>  events, and of the <a href="Poco.XML.CharacterData.html" title="class Poco::XML::CharacterData">CharacterData</a> node in DOMCharDataModified events. </p>
</div>
<h3><a name="18419">prevValue</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> &amp; prevValue() const;</p>
<div class="description">
<p>prevValue indicates the previous value of the <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> node in <a href="Poco.XML.MutationEvent.html#18437" title="Poco::XML::MutationEvent::DOMAttrModified">DOMAttrModified</a>  events, and of the <a href="Poco.XML.CharacterData.html" title="class Poco::XML::CharacterData">CharacterData</a> node in DOMCharDataModified events. </p>
</div>
<h3><a name="18418">relatedNode</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl"><a href="Poco.XML.Node.html" title="class Poco::XML::Node">Node</a> * relatedNode() const;</p>
<div class="description">
<p>relatedNode is used to identify a secondary node related to a mutation  event. For example, if a mutation event is dispatched to a node indicating that its parent has changed, the relatedNode is the  changed parent. If an event is instead dispatched to a subtree indicating a node was changed within it, the relatedNode is  the changed node. In the case of the <a href="Poco.XML.MutationEvent.html#18437" title="Poco::XML::MutationEvent::DOMAttrModified">DOMAttrModified</a> event it indicates the <a href="Poco.XML.Attr.html" title="class Poco::XML::Attr">Attr</a> node which was modified, added, or removed. </p>
</div>
<h2>Variables</h2>
<h3><a name="18437">DOMAttrModified</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> <a href="Poco.XML.MutationEvent.html#18437" title="Poco::XML::MutationEvent::DOMAttrModified">DOMAttrModified</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="18438">DOMCharacterDataModified</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> <a href="Poco.XML.MutationEvent.html#18438" title="Poco::XML::MutationEvent::DOMCharacterDataModified">DOMCharacterDataModified</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="18433">DOMNodeInserted</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> <a href="Poco.XML.MutationEvent.html#18433" title="Poco::XML::MutationEvent::DOMNodeInserted">DOMNodeInserted</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="18436">DOMNodeInsertedIntoDocument</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> <a href="Poco.XML.MutationEvent.html#18436" title="Poco::XML::MutationEvent::DOMNodeInsertedIntoDocument">DOMNodeInsertedIntoDocument</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="18434">DOMNodeRemoved</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> <a href="Poco.XML.MutationEvent.html#18434" title="Poco::XML::MutationEvent::DOMNodeRemoved">DOMNodeRemoved</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="18435">DOMNodeRemovedFromDocument</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> <a href="Poco.XML.MutationEvent.html#18435" title="Poco::XML::MutationEvent::DOMNodeRemovedFromDocument">DOMNodeRemovedFromDocument</a>;</p>
<div class="description">
<p></p>
</div>
<h3><a name="18432">DOMSubtreeModified</a> <img src="images/static.gif" alt="static" title="static" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">static const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> <a href="Poco.XML.MutationEvent.html#18432" title="Poco::XML::MutationEvent::DOMSubtreeModified">DOMSubtreeModified</a>;</p>
<div class="description">
<p></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>