File: Poco.XML.DocumentEvent.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 (50 lines) | stat: -rw-r--r-- 4,836 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
<!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::DocumentEvent</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 DocumentEvent</h1>
</div>
<div class="body">
<p>
<b>Library:</b> XML<br />
<b>Package:</b> DOM<br />
<b>Header:</b> Poco/DOM/DocumentEvent.h</p>
<h2>Description</h2>
<div class="description">
<p>The <a href="Poco.XML.DocumentEvent.html" title="class Poco::XML::DocumentEvent">DocumentEvent</a> interface provides a mechanism by which the user can create an <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> of a type supported by the implementation. It is expected that the <a href="Poco.XML.DocumentEvent.html" title="class Poco::XML::DocumentEvent">DocumentEvent</a> interface will be implemented on the same object which implements the <a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a> interface in an implementation which supports the <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> model. </p>
</div>
<h2>Inheritance</h2>
<p><b>Known Derived Classes: </b><a href="Poco.XML.Document.html" title="class Poco::XML::Document">Document</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.XML.DocumentEvent.html#18122" title="Poco::XML::DocumentEvent::createEvent()">createEvent</a></p>
<h2>Destructor</h2>
<h3><a name="18124">~DocumentEvent</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.DocumentEvent.html" title="class Poco::XML::DocumentEvent">DocumentEvent</a>();</p>
<div class="description">
<p></p>
</div>
<h2>Member Functions</h2>
<h3><a name="18122">createEvent</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> * createEvent(<br />&nbsp;&nbsp;&nbsp;&nbsp;const <a href="Poco.XML.html#19841" title="Poco::XML::XMLString">XMLString</a> &amp; eventType<br />) const = 0;</p>
<div class="description">
<p>Creates an event of the specified type. </p>
<p>The eventType parameter specifies the type of <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> interface to be created. If the <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> interface specified is supported by the implementation this method will return a new <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> of the interface type requested. If the <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> is to be dispatched via the dispatchEvent method the appropriate event init method must be called after creation in order to initialize the <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a>'s values. As an example, a user wishing to synthesize some kind of UIEvent would call createEvent with the parameter &quot;UIEvents&quot;. The initUIEvent method could then be called on the newly created UIEvent to set the specific type of UIEvent to be dispatched and set its context information. The createEvent method is used in creating Events when it is either inconvenient or unnecessary for the user to create an <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> themselves. In cases where the implementation provided <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> is insufficient, users may supply their own <a href="Poco.XML.Event.html" title="class Poco::XML::Event">Event</a> implementations for use with the dispatchEvent method. </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>