src/eric7/Documentation/Source/eric7.EricXML.TemplatesReader.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10423
299802979277
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.EricXML.TemplatesReader</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.EricXML.TemplatesReader</h1>
10
11 <p>
12 Module implementing a class for reading an XML templates file.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#TemplatesReader">TemplatesReader</a></td>
25 <td>Class for reading an XML tasks file.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="TemplatesReader" ID="TemplatesReader"></a>
36 <h2>TemplatesReader</h2>
37
38 <p>
39 Class for reading an XML tasks file.
40 </p>
41 <h3>Derived from</h3>
42 XMLStreamReaderBase
43 <h3>Class Attributes</h3>
44
45 <table>
46 <tr><td>supportedVersions</td></tr>
47 </table>
48 <h3>Class Methods</h3>
49
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Methods</h3>
54
55 <table>
56
57 <tr>
58 <td><a href="#TemplatesReader.__init__">TemplatesReader</a></td>
59 <td>Constructor</td>
60 </tr>
61 <tr>
62 <td><a href="#TemplatesReader.__readTemplate">__readTemplate</a></td>
63 <td>Private method to read the template definition.</td>
64 </tr>
65 <tr>
66 <td><a href="#TemplatesReader.__readTemplateGroup">__readTemplateGroup</a></td>
67 <td>Private method to read a template group.</td>
68 </tr>
69 <tr>
70 <td><a href="#TemplatesReader.readXML">readXML</a></td>
71 <td>Public method to read and parse the XML document.</td>
72 </tr>
73 </table>
74 <h3>Static Methods</h3>
75
76 <table>
77 <tr><td>None</td></tr>
78 </table>
79
80 <a NAME="TemplatesReader.__init__" ID="TemplatesReader.__init__"></a>
81 <h4>TemplatesReader (Constructor)</h4>
82 <b>TemplatesReader</b>(<i>device, viewer</i>)
83
84 <p>
85 Constructor
86 </p>
87 <dl>
88
89 <dt><i>device</i></dt>
90 <dd>
91 reference to the I/O device to read from (QIODevice)
92 </dd>
93 <dt><i>viewer</i></dt>
94 <dd>
95 reference to the template viewer object (TemplateViewer)
96 </dd>
97 </dl>
98 <a NAME="TemplatesReader.__readTemplate" ID="TemplatesReader.__readTemplate"></a>
99 <h4>TemplatesReader.__readTemplate</h4>
100 <b>__readTemplate</b>(<i></i>)
101
102 <p>
103 Private method to read the template definition.
104 </p>
105 <a NAME="TemplatesReader.__readTemplateGroup" ID="TemplatesReader.__readTemplateGroup"></a>
106 <h4>TemplatesReader.__readTemplateGroup</h4>
107 <b>__readTemplateGroup</b>(<i></i>)
108
109 <p>
110 Private method to read a template group.
111 </p>
112 <a NAME="TemplatesReader.readXML" ID="TemplatesReader.readXML"></a>
113 <h4>TemplatesReader.readXML</h4>
114 <b>readXML</b>(<i></i>)
115
116 <p>
117 Public method to read and parse the XML document.
118 </p>
119 <div align="right"><a href="#top">Up</a></div>
120 <hr />
121 </body></html>

eric ide

mercurial