|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' |
|
3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> |
|
4 <html><head> |
|
5 <title>eric5.E5XML.TemplatesHandler</title> |
|
6 <style> |
|
7 body { |
|
8 background:white; |
|
9 margin: 0em 1em 10em 1em; |
|
10 color: black; |
|
11 } |
|
12 |
|
13 h1 { color: white; background: #4FA4FF; } |
|
14 h2 { color: white; background: #4FA4FF; } |
|
15 h3 { color: white; background: #00557F; } |
|
16 h4 { color: white; background: #00557F; } |
|
17 |
|
18 a { color: #AA5500; } |
|
19 |
|
20 </style> |
|
21 </head> |
|
22 <body><a NAME="top" ID="top"></a> |
|
23 <h1>eric5.E5XML.TemplatesHandler</h1> |
|
24 <p> |
|
25 Module implementing the handler class for reading an XML templates file. |
|
26 </p> |
|
27 <h3>Global Attributes</h3> |
|
28 <table> |
|
29 <tr><td>None</td></tr> |
|
30 </table> |
|
31 <h3>Classes</h3> |
|
32 <table> |
|
33 <tr> |
|
34 <td><a href="#TemplatesHandler">TemplatesHandler</a></td> |
|
35 <td>Class implementing a sax handler to read an XML templates file.</td> |
|
36 </tr> |
|
37 </table> |
|
38 <h3>Functions</h3> |
|
39 <table> |
|
40 <tr><td>None</td></tr> |
|
41 </table> |
|
42 <hr /><hr /> |
|
43 <a NAME="TemplatesHandler" ID="TemplatesHandler"></a> |
|
44 <h2>TemplatesHandler</h2> |
|
45 <p> |
|
46 Class implementing a sax handler to read an XML templates file. |
|
47 </p> |
|
48 <h3>Derived from</h3> |
|
49 XMLHandlerBase |
|
50 <h3>Class Attributes</h3> |
|
51 <table> |
|
52 <tr><td>None</td></tr> |
|
53 </table> |
|
54 <h3>Methods</h3> |
|
55 <table> |
|
56 <tr> |
|
57 <td><a href="#TemplatesHandler.__init__">TemplatesHandler</a></td> |
|
58 <td>Constructor</td> |
|
59 </tr><tr> |
|
60 <td><a href="#TemplatesHandler.endTemplate">endTemplate</a></td> |
|
61 <td>Handler method for the "Template" end tag.</td> |
|
62 </tr><tr> |
|
63 <td><a href="#TemplatesHandler.endTemplateDescription">endTemplateDescription</a></td> |
|
64 <td>Handler method for the "TemplateDescription" end tag.</td> |
|
65 </tr><tr> |
|
66 <td><a href="#TemplatesHandler.endTemplateText">endTemplateText</a></td> |
|
67 <td>Handler method for the "TemplateText" end tag.</td> |
|
68 </tr><tr> |
|
69 <td><a href="#TemplatesHandler.getVersion">getVersion</a></td> |
|
70 <td>Public method to retrieve the version of the templates.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#TemplatesHandler.startDocumentTemplates">startDocumentTemplates</a></td> |
|
73 <td>Handler called, when the document parsing is started.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#TemplatesHandler.startTemplate">startTemplate</a></td> |
|
76 <td>Handler method for the "Template" start tag.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#TemplatesHandler.startTemplateGroup">startTemplateGroup</a></td> |
|
79 <td>Handler method for the "TemplateGroup" start tag.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#TemplatesHandler.startTemplates">startTemplates</a></td> |
|
82 <td>Handler method for the "Templates" start tag.</td> |
|
83 </tr> |
|
84 </table> |
|
85 <a NAME="TemplatesHandler.__init__" ID="TemplatesHandler.__init__"></a> |
|
86 <h4>TemplatesHandler (Constructor)</h4> |
|
87 <b>TemplatesHandler</b>(<i>templateViewer=None</i>) |
|
88 <p> |
|
89 Constructor |
|
90 </p><dl> |
|
91 <dt><i>templateViewer</i></dt> |
|
92 <dd> |
|
93 reference to the template viewer object |
|
94 </dd> |
|
95 </dl><a NAME="TemplatesHandler.endTemplate" ID="TemplatesHandler.endTemplate"></a> |
|
96 <h4>TemplatesHandler.endTemplate</h4> |
|
97 <b>endTemplate</b>(<i></i>) |
|
98 <p> |
|
99 Handler method for the "Template" end tag. |
|
100 </p><a NAME="TemplatesHandler.endTemplateDescription" ID="TemplatesHandler.endTemplateDescription"></a> |
|
101 <h4>TemplatesHandler.endTemplateDescription</h4> |
|
102 <b>endTemplateDescription</b>(<i></i>) |
|
103 <p> |
|
104 Handler method for the "TemplateDescription" end tag. |
|
105 </p><a NAME="TemplatesHandler.endTemplateText" ID="TemplatesHandler.endTemplateText"></a> |
|
106 <h4>TemplatesHandler.endTemplateText</h4> |
|
107 <b>endTemplateText</b>(<i></i>) |
|
108 <p> |
|
109 Handler method for the "TemplateText" end tag. |
|
110 </p><a NAME="TemplatesHandler.getVersion" ID="TemplatesHandler.getVersion"></a> |
|
111 <h4>TemplatesHandler.getVersion</h4> |
|
112 <b>getVersion</b>(<i></i>) |
|
113 <p> |
|
114 Public method to retrieve the version of the templates. |
|
115 </p><dl> |
|
116 <dt>Returns:</dt> |
|
117 <dd> |
|
118 String containing the version number. |
|
119 </dd> |
|
120 </dl><a NAME="TemplatesHandler.startDocumentTemplates" ID="TemplatesHandler.startDocumentTemplates"></a> |
|
121 <h4>TemplatesHandler.startDocumentTemplates</h4> |
|
122 <b>startDocumentTemplates</b>(<i></i>) |
|
123 <p> |
|
124 Handler called, when the document parsing is started. |
|
125 </p><a NAME="TemplatesHandler.startTemplate" ID="TemplatesHandler.startTemplate"></a> |
|
126 <h4>TemplatesHandler.startTemplate</h4> |
|
127 <b>startTemplate</b>(<i>attrs</i>) |
|
128 <p> |
|
129 Handler method for the "Template" start tag. |
|
130 </p><dl> |
|
131 <dt><i>attrs</i></dt> |
|
132 <dd> |
|
133 list of tag attributes |
|
134 </dd> |
|
135 </dl><a NAME="TemplatesHandler.startTemplateGroup" ID="TemplatesHandler.startTemplateGroup"></a> |
|
136 <h4>TemplatesHandler.startTemplateGroup</h4> |
|
137 <b>startTemplateGroup</b>(<i>attrs</i>) |
|
138 <p> |
|
139 Handler method for the "TemplateGroup" start tag. |
|
140 </p><dl> |
|
141 <dt><i>attrs</i></dt> |
|
142 <dd> |
|
143 list of tag attributes |
|
144 </dd> |
|
145 </dl><a NAME="TemplatesHandler.startTemplates" ID="TemplatesHandler.startTemplates"></a> |
|
146 <h4>TemplatesHandler.startTemplates</h4> |
|
147 <b>startTemplates</b>(<i>attrs</i>) |
|
148 <p> |
|
149 Handler method for the "Templates" start tag. |
|
150 </p><dl> |
|
151 <dt><i>attrs</i></dt> |
|
152 <dd> |
|
153 list of tag attributes |
|
154 </dd> |
|
155 </dl> |
|
156 <div align="right"><a href="#top">Up</a></div> |
|
157 <hr /> |
|
158 </body></html> |