Documentation/Source/eric5.E5XML.UserProjectReader.html

Sat, 20 Aug 2011 17:24:33 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 20 Aug 2011 17:24:33 +0200
changeset 1229
a8207dc73672
parent 1228
7afaf2fca55b
child 2367
78f6c8193d37
permissions
-rw-r--r--

Fixed an issue in the source documentor and regenerated the source docu.

615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
1 <?xml version="1.0" encoding="utf-8"?>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
4 <html><head>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <title>eric5.E5XML.UserProjectReader</title>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 <style>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 body {
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 background: #EDECE6;
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 margin: 0em 1em 10em 1em;
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 color: black;
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11 }
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
12
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
13 h1 { color: white; background: #85774A; }
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
14 h2 { color: white; background: #85774A; }
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
15 h3 { color: white; background: #9D936E; }
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16 h4 { color: white; background: #9D936E; }
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18 a { color: #BA6D36; }
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </style>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 </head>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <body><a NAME="top" ID="top"></a>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <h1>eric5.E5XML.UserProjectReader</h1>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 <p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 Module implementing a class for reading an XML user project properties file.
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 </p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <h3>Global Attributes</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 <tr><td>None</td></tr>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 </table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <h3>Classes</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <tr>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
34 <td><a href="#UserProjectReader">UserProjectReader</a></td>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 <td>Class for reading an XML user project properties file.</td>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </tr>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 </table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <h3>Functions</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 <tr><td>None</td></tr>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 </table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <hr /><hr />
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <a NAME="UserProjectReader" ID="UserProjectReader"></a>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <h2>UserProjectReader</h2>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 <p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 Class for reading an XML user project properties file.
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 </p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 <h3>Derived from</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 XMLStreamReaderBase
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <h3>Class Attributes</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
52 <tr><td>supportedVersions</td></tr>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
53 </table>
1228
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
54 <h3>Class Methods</h3>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
55 <table>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
56 <tr><td>None</td></tr>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
57 </table>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <h3>Methods</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
60 <tr>
1229
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
61 <td><a href="#UserProjectReader.__init__">UserProjectReader</a></td>
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
62 <td>Constructor</td>
a8207dc73672 Fixed an issue in the source documentor and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1228
diff changeset
63 </tr><tr>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
64 <td><a href="#UserProjectReader.readXML">readXML</a></td>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 <td>Public method to read and parse the XML document.</td>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </tr>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
67 </table>
1228
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
68 <h3>Static Methods</h3>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
69 <table>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
70 <tr><td>None</td></tr>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
71 </table>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <a NAME="UserProjectReader.__init__" ID="UserProjectReader.__init__"></a>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <h4>UserProjectReader (Constructor)</h4>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <b>UserProjectReader</b>(<i>device, project</i>)
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 <p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 Constructor
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 </p><dl>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <dt><i>device</i></dt>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 <dd>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 reference to the I/O device to read from (QIODevice)
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 </dd><dt><i>project</i></dt>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 <dd>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 Reference to the project object to store the
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 information into.
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 </dd>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 </dl><a NAME="UserProjectReader.readXML" ID="UserProjectReader.readXML"></a>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <h4>UserProjectReader.readXML</h4>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
88 <b>readXML</b>(<i></i>)
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 <p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 Public method to read and parse the XML document.
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 </p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 <div align="right"><a href="#top">Up</a></div>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 <hr />
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
94 </body></html>

eric ide

mercurial