Documentation/Source/eric5.E5XML.UserProjectReader.html

Sat, 26 Jan 2013 12:44:46 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Sat, 26 Jan 2013 12:44:46 +0100
branch
5_3_x
changeset 2374
f78ee0e8f96c
parent 1229
a8207dc73672
child 2386
bf6f0ded6071
permissions
-rw-r--r--

Regenerated the source docu with the HTML5 generator.

2374
f78ee0e8f96c Regenerated the source docu with the HTML5 generator.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1229
diff changeset
1 <!DOCTYPE html>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric5.E5XML.UserProjectReader</title>
2374
f78ee0e8f96c Regenerated the source docu with the HTML5 generator.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 1229
diff changeset
4 <meta charset="UTF-8">
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
7 background: #EDECE6;
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 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
9 color: black;
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
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 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
13 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
14 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
15 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
16
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
17 a { color: #BA6D36; }
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <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
22 <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
23 <p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
24 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
25 </p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 <h3>Global Attributes</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <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
29 </table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <h3>Classes</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <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
34 <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
35 </tr>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <h3>Functions</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <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
40 </table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <hr /><hr />
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <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
43 <h2>UserProjectReader</h2>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
45 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
46 </p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Derived from</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
48 XMLStreamReaderBase
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <h3>Class Attributes</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <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
52 </table>
1228
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
53 <h3>Class Methods</h3>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
54 <table>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
55 <tr><td>None</td></tr>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
56 </table>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Methods</h3>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <table>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
59 <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
60 <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
61 <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
62 </tr><tr>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <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
64 <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
65 </tr>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
66 </table>
1228
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
67 <h3>Static Methods</h3>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
68 <table>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
69 <tr><td>None</td></tr>
7afaf2fca55b Updated source docu with new soutce documentor.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 615
diff changeset
70 </table>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <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
72 <h4>UserProjectReader (Constructor)</h4>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
73 <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
74 <p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
75 Constructor
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 </p><dl>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
77 <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
78 <dd>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
79 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
80 </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
81 <dd>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
82 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
83 information into.
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 </dd>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 </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
86 <h4>UserProjectReader.readXML</h4>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <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
88 <p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 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
90 </p>
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <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
92 <hr />
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
93 </body></html>

eric ide

mercurial