Documentation/Source/eric5.E5XML.UserProjectWriter.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>
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
2 <html><head>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
3 <title>eric5.E5XML.UserProjectWriter</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">
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
5 <style>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
6 body {
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
7 background: #EDECE6;
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
8 margin: 0em 1em 10em 1em;
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
9 color: black;
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
10 }
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
11
409
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
12 h1 { color: white; background: #85774A; }
0ea528e80202 Added another style for the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 58
diff changeset
13 h2 { color: white; background: #85774A; }
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
14 h3 { color: white; background: #9D936E; }
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
15 h4 { color: white; background: #9D936E; }
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
16
440
69ace3e2dcf6 Fine tuned the new default style and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 409
diff changeset
17 a { color: #BA6D36; }
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
18
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
19 </style>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
20 </head>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
21 <body><a NAME="top" ID="top"></a>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
22 <h1>eric5.E5XML.UserProjectWriter</h1>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
23 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 50
diff changeset
24 Module implementing the writer class for writing an XML user project properties file.
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
25 </p>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
26 <h3>Global Attributes</h3>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
27 <table>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
28 <tr><td>None</td></tr>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
29 </table>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
30 <h3>Classes</h3>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
31 <table>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
32 <tr>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
33 <td><a href="#UserProjectWriter">UserProjectWriter</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 50
diff changeset
34 <td>Class implementing the writer class for writing an XML user project properties file.</td>
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
35 </tr>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
36 </table>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
37 <h3>Functions</h3>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
38 <table>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
39 <tr><td>None</td></tr>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
40 </table>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
41 <hr /><hr />
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
42 <a NAME="UserProjectWriter" ID="UserProjectWriter"></a>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
43 <h2>UserProjectWriter</h2>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
44 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 50
diff changeset
45 Class implementing the writer class for writing an XML user project properties file.
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
46 </p>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
47 <h3>Derived from</h3>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
48 XMLStreamWriterBase
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
49 <h3>Class Attributes</h3>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
50 <table>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
51 <tr><td>None</td></tr>
a36eecf45b2e Renamed E4XML to E5XML.
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>
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
57 <h3>Methods</h3>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
58 <table>
a36eecf45b2e Renamed E4XML to E5XML.
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="#UserProjectWriter.__init__">UserProjectWriter</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>
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
63 <td><a href="#UserProjectWriter.writeXML">writeXML</a></td>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 50
diff changeset
64 <td>Public method to write the XML to the file.</td>
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
65 </tr>
a36eecf45b2e Renamed E4XML to E5XML.
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>
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
71 <a NAME="UserProjectWriter.__init__" ID="UserProjectWriter.__init__"></a>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
72 <h4>UserProjectWriter (Constructor)</h4>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
73 <b>UserProjectWriter</b>(<i>device, projectName</i>)
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
74 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 50
diff changeset
75 Constructor
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
76 </p><dl>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
77 <dt><i>device</i></dt>
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
78 <dd>
615
c8dd16cc69ce Finished porting XML handling code to use QXmlStreamReader and QXmlStreamWriter.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 440
diff changeset
79 reference to the I/O device to write to (QIODevice)
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
80 </dd><dt><i>projectName</i></dt>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
81 <dd>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 50
diff changeset
82 name of the project (string)
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
83 </dd>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
84 </dl><a NAME="UserProjectWriter.writeXML" ID="UserProjectWriter.writeXML"></a>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
85 <h4>UserProjectWriter.writeXML</h4>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
86 <b>writeXML</b>(<i></i>)
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
87 <p>
58
37f0444c3479 Corrected the version docu and regenerated the source docu.
Detlev Offenbach <detlev@die-offenbachs.de>
parents: 50
diff changeset
88 Public method to write the XML to the file.
50
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
89 </p>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
90 <div align="right"><a href="#top">Up</a></div>
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
91 <hr />
a36eecf45b2e Renamed E4XML to E5XML.
Detlev Offenbach <detlev@die-offenbachs.de>
parents:
diff changeset
92 </body></html>

eric ide

mercurial