eric6/Documentation/Source/eric6.Templates.TemplateViewer.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7989
a21d673a8f99
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.Templates.TemplateViewer</h1> 23 <h1>eric6.Templates.TemplateViewer</h1>
24
23 <p> 25 <p>
24 Module implementing a template viewer and associated classes. 26 Module implementing a template viewer and associated classes.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#TemplateEntry">TemplateEntry</a></td> 38 <td><a href="#TemplateEntry">TemplateEntry</a></td>
34 <td>Class immplementing a template entry.</td> 39 <td>Class immplementing a template entry.</td>
35 </tr><tr> 40 </tr>
41 <tr>
36 <td><a href="#TemplateGroup">TemplateGroup</a></td> 42 <td><a href="#TemplateGroup">TemplateGroup</a></td>
37 <td>Class implementing a template group.</td> 43 <td>Class implementing a template group.</td>
38 </tr><tr> 44 </tr>
45 <tr>
39 <td><a href="#TemplateViewer">TemplateViewer</a></td> 46 <td><a href="#TemplateViewer">TemplateViewer</a></td>
40 <td>Class implementing the template viewer.</td> 47 <td>Class implementing the template viewer.</td>
41 </tr> 48 </tr>
42 </table> 49 </table>
43 <h3>Functions</h3> 50 <h3>Functions</h3>
51
44 <table> 52 <table>
45 <tr><td>None</td></tr> 53 <tr><td>None</td></tr>
46 </table> 54 </table>
47 <hr /><hr /> 55 <hr />
56 <hr />
48 <a NAME="TemplateEntry" ID="TemplateEntry"></a> 57 <a NAME="TemplateEntry" ID="TemplateEntry"></a>
49 <h2>TemplateEntry</h2> 58 <h2>TemplateEntry</h2>
59
50 <p> 60 <p>
51 Class immplementing a template entry. 61 Class immplementing a template entry.
52 </p> 62 </p>
53 <h3>Derived from</h3> 63 <h3>Derived from</h3>
54 QTreeWidgetItem 64 QTreeWidgetItem
55 <h3>Class Attributes</h3> 65 <h3>Class Attributes</h3>
66
56 <table> 67 <table>
57 <tr><td>None</td></tr> 68 <tr><td>None</td></tr>
58 </table> 69 </table>
59 <h3>Class Methods</h3> 70 <h3>Class Methods</h3>
71
60 <table> 72 <table>
61 <tr><td>None</td></tr> 73 <tr><td>None</td></tr>
62 </table> 74 </table>
63 <h3>Methods</h3> 75 <h3>Methods</h3>
64 <table> 76
77 <table>
78
65 <tr> 79 <tr>
66 <td><a href="#TemplateEntry.__init__">TemplateEntry</a></td> 80 <td><a href="#TemplateEntry.__init__">TemplateEntry</a></td>
67 <td>Constructor</td> 81 <td>Constructor</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#TemplateEntry.__displayText">__displayText</a></td> 84 <td><a href="#TemplateEntry.__displayText">__displayText</a></td>
70 <td>Private method to generate the display text.</td> 85 <td>Private method to generate the display text.</td>
71 </tr><tr> 86 </tr>
87 <tr>
72 <td><a href="#TemplateEntry.__expandFormattedVariable">__expandFormattedVariable</a></td> 88 <td><a href="#TemplateEntry.__expandFormattedVariable">__expandFormattedVariable</a></td>
73 <td>Private method to expand a template variable with special formatting.</td> 89 <td>Private method to expand a template variable with special formatting.</td>
74 </tr><tr> 90 </tr>
91 <tr>
75 <td><a href="#TemplateEntry.__extractVariables">__extractVariables</a></td> 92 <td><a href="#TemplateEntry.__extractVariables">__extractVariables</a></td>
76 <td>Private method to retrieve the list of variables.</td> 93 <td>Private method to retrieve the list of variables.</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#TemplateEntry.getDescription">getDescription</a></td> 96 <td><a href="#TemplateEntry.getDescription">getDescription</a></td>
79 <td>Public method to get the description of the entry.</td> 97 <td>Public method to get the description of the entry.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#TemplateEntry.getExpandedText">getExpandedText</a></td> 100 <td><a href="#TemplateEntry.getExpandedText">getExpandedText</a></td>
82 <td>Public method to get the template text with all variables expanded.</td> 101 <td>Public method to get the template text with all variables expanded.</td>
83 </tr><tr> 102 </tr>
103 <tr>
84 <td><a href="#TemplateEntry.getGroupName">getGroupName</a></td> 104 <td><a href="#TemplateEntry.getGroupName">getGroupName</a></td>
85 <td>Public method to get the name of the group this entry belongs to.</td> 105 <td>Public method to get the name of the group this entry belongs to.</td>
86 </tr><tr> 106 </tr>
107 <tr>
87 <td><a href="#TemplateEntry.getName">getName</a></td> 108 <td><a href="#TemplateEntry.getName">getName</a></td>
88 <td>Public method to get the name of the entry.</td> 109 <td>Public method to get the name of the entry.</td>
89 </tr><tr> 110 </tr>
111 <tr>
90 <td><a href="#TemplateEntry.getTemplateText">getTemplateText</a></td> 112 <td><a href="#TemplateEntry.getTemplateText">getTemplateText</a></td>
91 <td>Public method to get the template text.</td> 113 <td>Public method to get the template text.</td>
92 </tr><tr> 114 </tr>
115 <tr>
93 <td><a href="#TemplateEntry.getVariables">getVariables</a></td> 116 <td><a href="#TemplateEntry.getVariables">getVariables</a></td>
94 <td>Public method to get the list of variables.</td> 117 <td>Public method to get the list of variables.</td>
95 </tr><tr> 118 </tr>
119 <tr>
96 <td><a href="#TemplateEntry.setDescription">setDescription</a></td> 120 <td><a href="#TemplateEntry.setDescription">setDescription</a></td>
97 <td>Public method to update the description of the entry.</td> 121 <td>Public method to update the description of the entry.</td>
98 </tr><tr> 122 </tr>
123 <tr>
99 <td><a href="#TemplateEntry.setName">setName</a></td> 124 <td><a href="#TemplateEntry.setName">setName</a></td>
100 <td>Public method to update the name of the entry.</td> 125 <td>Public method to update the name of the entry.</td>
101 </tr><tr> 126 </tr>
127 <tr>
102 <td><a href="#TemplateEntry.setTemplateText">setTemplateText</a></td> 128 <td><a href="#TemplateEntry.setTemplateText">setTemplateText</a></td>
103 <td>Public method to update the template text.</td> 129 <td>Public method to update the template text.</td>
104 </tr> 130 </tr>
105 </table> 131 </table>
106 <h3>Static Methods</h3> 132 <h3>Static Methods</h3>
133
107 <table> 134 <table>
108 <tr><td>None</td></tr> 135 <tr><td>None</td></tr>
109 </table> 136 </table>
137
110 <a NAME="TemplateEntry.__init__" ID="TemplateEntry.__init__"></a> 138 <a NAME="TemplateEntry.__init__" ID="TemplateEntry.__init__"></a>
111 <h4>TemplateEntry (Constructor)</h4> 139 <h4>TemplateEntry (Constructor)</h4>
112 <b>TemplateEntry</b>(<i>parent, name, description, templateText</i>) 140 <b>TemplateEntry</b>(<i>parent, name, description, templateText</i>)
141
113 <p> 142 <p>
114 Constructor 143 Constructor
115 </p><dl> 144 </p>
145 <dl>
146
116 <dt><i>parent</i></dt> 147 <dt><i>parent</i></dt>
117 <dd> 148 <dd>
118 parent widget of the template entry (QWidget) 149 parent widget of the template entry (QWidget)
119 </dd><dt><i>name</i></dt> 150 </dd>
151 <dt><i>name</i></dt>
120 <dd> 152 <dd>
121 name of the entry (string) 153 name of the entry (string)
122 </dd><dt><i>description</i></dt> 154 </dd>
155 <dt><i>description</i></dt>
123 <dd> 156 <dd>
124 descriptive text for the template (string) 157 descriptive text for the template (string)
125 </dd><dt><i>templateText</i></dt> 158 </dd>
159 <dt><i>templateText</i></dt>
126 <dd> 160 <dd>
127 text of the template entry (string) 161 text of the template entry (string)
128 </dd> 162 </dd>
129 </dl><a NAME="TemplateEntry.__displayText" ID="TemplateEntry.__displayText"></a> 163 </dl>
164 <a NAME="TemplateEntry.__displayText" ID="TemplateEntry.__displayText"></a>
130 <h4>TemplateEntry.__displayText</h4> 165 <h4>TemplateEntry.__displayText</h4>
131 <b>__displayText</b>(<i></i>) 166 <b>__displayText</b>(<i></i>)
167
132 <p> 168 <p>
133 Private method to generate the display text. 169 Private method to generate the display text.
134 </p><dl> 170 </p>
171 <dl>
135 <dt>Returns:</dt> 172 <dt>Returns:</dt>
136 <dd> 173 <dd>
137 display text (string) 174 display text (string)
138 </dd> 175 </dd>
139 </dl><a NAME="TemplateEntry.__expandFormattedVariable" ID="TemplateEntry.__expandFormattedVariable"></a> 176 </dl>
177 <a NAME="TemplateEntry.__expandFormattedVariable" ID="TemplateEntry.__expandFormattedVariable"></a>
140 <h4>TemplateEntry.__expandFormattedVariable</h4> 178 <h4>TemplateEntry.__expandFormattedVariable</h4>
141 <b>__expandFormattedVariable</b>(<i>var, val, txt</i>) 179 <b>__expandFormattedVariable</b>(<i>var, val, txt</i>)
180
142 <p> 181 <p>
143 Private method to expand a template variable with special formatting. 182 Private method to expand a template variable with special formatting.
144 </p><dl> 183 </p>
184 <dl>
185
145 <dt><i>var</i></dt> 186 <dt><i>var</i></dt>
146 <dd> 187 <dd>
147 template variable name (string) 188 template variable name (string)
148 </dd><dt><i>val</i></dt> 189 </dd>
190 <dt><i>val</i></dt>
149 <dd> 191 <dd>
150 value of the template variable (string) 192 value of the template variable (string)
151 </dd><dt><i>txt</i></dt> 193 </dd>
194 <dt><i>txt</i></dt>
152 <dd> 195 <dd>
153 template text (string) 196 template text (string)
154 </dd> 197 </dd>
155 </dl><dl> 198 </dl>
199 <dl>
156 <dt>Returns:</dt> 200 <dt>Returns:</dt>
157 <dd> 201 <dd>
158 expanded and formatted variable (string) 202 expanded and formatted variable (string)
159 </dd> 203 </dd>
160 </dl><a NAME="TemplateEntry.__extractVariables" ID="TemplateEntry.__extractVariables"></a> 204 </dl>
205 <a NAME="TemplateEntry.__extractVariables" ID="TemplateEntry.__extractVariables"></a>
161 <h4>TemplateEntry.__extractVariables</h4> 206 <h4>TemplateEntry.__extractVariables</h4>
162 <b>__extractVariables</b>(<i></i>) 207 <b>__extractVariables</b>(<i></i>)
208
163 <p> 209 <p>
164 Private method to retrieve the list of variables. 210 Private method to retrieve the list of variables.
165 </p><a NAME="TemplateEntry.getDescription" ID="TemplateEntry.getDescription"></a> 211 </p>
212 <a NAME="TemplateEntry.getDescription" ID="TemplateEntry.getDescription"></a>
166 <h4>TemplateEntry.getDescription</h4> 213 <h4>TemplateEntry.getDescription</h4>
167 <b>getDescription</b>(<i></i>) 214 <b>getDescription</b>(<i></i>)
215
168 <p> 216 <p>
169 Public method to get the description of the entry. 217 Public method to get the description of the entry.
170 </p><dl> 218 </p>
219 <dl>
171 <dt>Returns:</dt> 220 <dt>Returns:</dt>
172 <dd> 221 <dd>
173 description of the entry (string) 222 description of the entry (string)
174 </dd> 223 </dd>
175 </dl><a NAME="TemplateEntry.getExpandedText" ID="TemplateEntry.getExpandedText"></a> 224 </dl>
225 <a NAME="TemplateEntry.getExpandedText" ID="TemplateEntry.getExpandedText"></a>
176 <h4>TemplateEntry.getExpandedText</h4> 226 <h4>TemplateEntry.getExpandedText</h4>
177 <b>getExpandedText</b>(<i>varDict, indent</i>) 227 <b>getExpandedText</b>(<i>varDict, indent</i>)
228
178 <p> 229 <p>
179 Public method to get the template text with all variables expanded. 230 Public method to get the template text with all variables expanded.
180 </p><dl> 231 </p>
232 <dl>
233
181 <dt><i>varDict</i></dt> 234 <dt><i>varDict</i></dt>
182 <dd> 235 <dd>
183 dictionary containing the texts of each variable 236 dictionary containing the texts of each variable
184 with the variable name as key. 237 with the variable name as key.
185 </dd><dt><i>indent</i></dt> 238 </dd>
239 <dt><i>indent</i></dt>
186 <dd> 240 <dd>
187 indentation of the line receiving he expanded 241 indentation of the line receiving he expanded
188 template text (string) 242 template text (string)
189 </dd> 243 </dd>
190 </dl><dl> 244 </dl>
245 <dl>
191 <dt>Returns:</dt> 246 <dt>Returns:</dt>
192 <dd> 247 <dd>
193 a tuple of the expanded template text (string), the 248 a tuple of the expanded template text (string), the
194 number of lines (integer) and the length of the last line (integer) 249 number of lines (integer) and the length of the last line (integer)
195 </dd> 250 </dd>
196 </dl><a NAME="TemplateEntry.getGroupName" ID="TemplateEntry.getGroupName"></a> 251 </dl>
252 <a NAME="TemplateEntry.getGroupName" ID="TemplateEntry.getGroupName"></a>
197 <h4>TemplateEntry.getGroupName</h4> 253 <h4>TemplateEntry.getGroupName</h4>
198 <b>getGroupName</b>(<i></i>) 254 <b>getGroupName</b>(<i></i>)
255
199 <p> 256 <p>
200 Public method to get the name of the group this entry belongs to. 257 Public method to get the name of the group this entry belongs to.
201 </p><dl> 258 </p>
259 <dl>
202 <dt>Returns:</dt> 260 <dt>Returns:</dt>
203 <dd> 261 <dd>
204 name of the group containing this entry (string) 262 name of the group containing this entry (string)
205 </dd> 263 </dd>
206 </dl><a NAME="TemplateEntry.getName" ID="TemplateEntry.getName"></a> 264 </dl>
265 <a NAME="TemplateEntry.getName" ID="TemplateEntry.getName"></a>
207 <h4>TemplateEntry.getName</h4> 266 <h4>TemplateEntry.getName</h4>
208 <b>getName</b>(<i></i>) 267 <b>getName</b>(<i></i>)
268
209 <p> 269 <p>
210 Public method to get the name of the entry. 270 Public method to get the name of the entry.
211 </p><dl> 271 </p>
272 <dl>
212 <dt>Returns:</dt> 273 <dt>Returns:</dt>
213 <dd> 274 <dd>
214 name of the entry (string) 275 name of the entry (string)
215 </dd> 276 </dd>
216 </dl><a NAME="TemplateEntry.getTemplateText" ID="TemplateEntry.getTemplateText"></a> 277 </dl>
278 <a NAME="TemplateEntry.getTemplateText" ID="TemplateEntry.getTemplateText"></a>
217 <h4>TemplateEntry.getTemplateText</h4> 279 <h4>TemplateEntry.getTemplateText</h4>
218 <b>getTemplateText</b>(<i></i>) 280 <b>getTemplateText</b>(<i></i>)
281
219 <p> 282 <p>
220 Public method to get the template text. 283 Public method to get the template text.
221 </p><dl> 284 </p>
285 <dl>
222 <dt>Returns:</dt> 286 <dt>Returns:</dt>
223 <dd> 287 <dd>
224 the template text (string) 288 the template text (string)
225 </dd> 289 </dd>
226 </dl><a NAME="TemplateEntry.getVariables" ID="TemplateEntry.getVariables"></a> 290 </dl>
291 <a NAME="TemplateEntry.getVariables" ID="TemplateEntry.getVariables"></a>
227 <h4>TemplateEntry.getVariables</h4> 292 <h4>TemplateEntry.getVariables</h4>
228 <b>getVariables</b>(<i></i>) 293 <b>getVariables</b>(<i></i>)
294
229 <p> 295 <p>
230 Public method to get the list of variables. 296 Public method to get the list of variables.
231 </p><dl> 297 </p>
298 <dl>
232 <dt>Returns:</dt> 299 <dt>Returns:</dt>
233 <dd> 300 <dd>
234 list of variables (list of strings) 301 list of variables (list of strings)
235 </dd> 302 </dd>
236 </dl><a NAME="TemplateEntry.setDescription" ID="TemplateEntry.setDescription"></a> 303 </dl>
304 <a NAME="TemplateEntry.setDescription" ID="TemplateEntry.setDescription"></a>
237 <h4>TemplateEntry.setDescription</h4> 305 <h4>TemplateEntry.setDescription</h4>
238 <b>setDescription</b>(<i>description</i>) 306 <b>setDescription</b>(<i>description</i>)
307
239 <p> 308 <p>
240 Public method to update the description of the entry. 309 Public method to update the description of the entry.
241 </p><dl> 310 </p>
311 <dl>
312
242 <dt><i>description</i></dt> 313 <dt><i>description</i></dt>
243 <dd> 314 <dd>
244 description of the entry (string) 315 description of the entry (string)
245 </dd> 316 </dd>
246 </dl><a NAME="TemplateEntry.setName" ID="TemplateEntry.setName"></a> 317 </dl>
318 <a NAME="TemplateEntry.setName" ID="TemplateEntry.setName"></a>
247 <h4>TemplateEntry.setName</h4> 319 <h4>TemplateEntry.setName</h4>
248 <b>setName</b>(<i>name</i>) 320 <b>setName</b>(<i>name</i>)
321
249 <p> 322 <p>
250 Public method to update the name of the entry. 323 Public method to update the name of the entry.
251 </p><dl> 324 </p>
325 <dl>
326
252 <dt><i>name</i></dt> 327 <dt><i>name</i></dt>
253 <dd> 328 <dd>
254 name of the entry (string) 329 name of the entry (string)
255 </dd> 330 </dd>
256 </dl><a NAME="TemplateEntry.setTemplateText" ID="TemplateEntry.setTemplateText"></a> 331 </dl>
332 <a NAME="TemplateEntry.setTemplateText" ID="TemplateEntry.setTemplateText"></a>
257 <h4>TemplateEntry.setTemplateText</h4> 333 <h4>TemplateEntry.setTemplateText</h4>
258 <b>setTemplateText</b>(<i>templateText</i>) 334 <b>setTemplateText</b>(<i>templateText</i>)
335
259 <p> 336 <p>
260 Public method to update the template text. 337 Public method to update the template text.
261 </p><dl> 338 </p>
339 <dl>
340
262 <dt><i>templateText</i></dt> 341 <dt><i>templateText</i></dt>
263 <dd> 342 <dd>
264 text of the template entry (string) 343 text of the template entry (string)
265 </dd> 344 </dd>
266 </dl> 345 </dl>
267 <div align="right"><a href="#top">Up</a></div> 346 <div align="right"><a href="#top">Up</a></div>
268 <hr /><hr /> 347 <hr />
348 <hr />
269 <a NAME="TemplateGroup" ID="TemplateGroup"></a> 349 <a NAME="TemplateGroup" ID="TemplateGroup"></a>
270 <h2>TemplateGroup</h2> 350 <h2>TemplateGroup</h2>
351
271 <p> 352 <p>
272 Class implementing a template group. 353 Class implementing a template group.
273 </p> 354 </p>
274 <h3>Derived from</h3> 355 <h3>Derived from</h3>
275 QTreeWidgetItem 356 QTreeWidgetItem
276 <h3>Class Attributes</h3> 357 <h3>Class Attributes</h3>
358
277 <table> 359 <table>
278 <tr><td>None</td></tr> 360 <tr><td>None</td></tr>
279 </table> 361 </table>
280 <h3>Class Methods</h3> 362 <h3>Class Methods</h3>
363
281 <table> 364 <table>
282 <tr><td>None</td></tr> 365 <tr><td>None</td></tr>
283 </table> 366 </table>
284 <h3>Methods</h3> 367 <h3>Methods</h3>
285 <table> 368
369 <table>
370
286 <tr> 371 <tr>
287 <td><a href="#TemplateGroup.__init__">TemplateGroup</a></td> 372 <td><a href="#TemplateGroup.__init__">TemplateGroup</a></td>
288 <td>Constructor</td> 373 <td>Constructor</td>
289 </tr><tr> 374 </tr>
375 <tr>
290 <td><a href="#TemplateGroup.addEntry">addEntry</a></td> 376 <td><a href="#TemplateGroup.addEntry">addEntry</a></td>
291 <td>Public method to add a template entry to this group.</td> 377 <td>Public method to add a template entry to this group.</td>
292 </tr><tr> 378 </tr>
379 <tr>
293 <td><a href="#TemplateGroup.getAllEntries">getAllEntries</a></td> 380 <td><a href="#TemplateGroup.getAllEntries">getAllEntries</a></td>
294 <td>Public method to retrieve all entries.</td> 381 <td>Public method to retrieve all entries.</td>
295 </tr><tr> 382 </tr>
383 <tr>
296 <td><a href="#TemplateGroup.getEntry">getEntry</a></td> 384 <td><a href="#TemplateGroup.getEntry">getEntry</a></td>
297 <td>Public method to get an entry.</td> 385 <td>Public method to get an entry.</td>
298 </tr><tr> 386 </tr>
387 <tr>
299 <td><a href="#TemplateGroup.getEntryNames">getEntryNames</a></td> 388 <td><a href="#TemplateGroup.getEntryNames">getEntryNames</a></td>
300 <td>Public method to get the names of all entries, who's name starts with the given string.</td> 389 <td>Public method to get the names of all entries, who's name starts with the given string.</td>
301 </tr><tr> 390 </tr>
391 <tr>
302 <td><a href="#TemplateGroup.getLanguage">getLanguage</a></td> 392 <td><a href="#TemplateGroup.getLanguage">getLanguage</a></td>
303 <td>Public method to get the name of the group.</td> 393 <td>Public method to get the name of the group.</td>
304 </tr><tr> 394 </tr>
395 <tr>
305 <td><a href="#TemplateGroup.getName">getName</a></td> 396 <td><a href="#TemplateGroup.getName">getName</a></td>
306 <td>Public method to get the name of the group.</td> 397 <td>Public method to get the name of the group.</td>
307 </tr><tr> 398 </tr>
399 <tr>
308 <td><a href="#TemplateGroup.hasEntry">hasEntry</a></td> 400 <td><a href="#TemplateGroup.hasEntry">hasEntry</a></td>
309 <td>Public method to check, if the group has an entry with the given name.</td> 401 <td>Public method to check, if the group has an entry with the given name.</td>
310 </tr><tr> 402 </tr>
403 <tr>
311 <td><a href="#TemplateGroup.removeAllEntries">removeAllEntries</a></td> 404 <td><a href="#TemplateGroup.removeAllEntries">removeAllEntries</a></td>
312 <td>Public method to remove all template entries of this group.</td> 405 <td>Public method to remove all template entries of this group.</td>
313 </tr><tr> 406 </tr>
407 <tr>
314 <td><a href="#TemplateGroup.removeEntry">removeEntry</a></td> 408 <td><a href="#TemplateGroup.removeEntry">removeEntry</a></td>
315 <td>Public method to remove a template entry from this group.</td> 409 <td>Public method to remove a template entry from this group.</td>
316 </tr><tr> 410 </tr>
411 <tr>
317 <td><a href="#TemplateGroup.setLanguage">setLanguage</a></td> 412 <td><a href="#TemplateGroup.setLanguage">setLanguage</a></td>
318 <td>Public method to update the name of the group.</td> 413 <td>Public method to update the name of the group.</td>
319 </tr><tr> 414 </tr>
415 <tr>
320 <td><a href="#TemplateGroup.setName">setName</a></td> 416 <td><a href="#TemplateGroup.setName">setName</a></td>
321 <td>Public method to update the name of the group.</td> 417 <td>Public method to update the name of the group.</td>
322 </tr> 418 </tr>
323 </table> 419 </table>
324 <h3>Static Methods</h3> 420 <h3>Static Methods</h3>
421
325 <table> 422 <table>
326 <tr><td>None</td></tr> 423 <tr><td>None</td></tr>
327 </table> 424 </table>
425
328 <a NAME="TemplateGroup.__init__" ID="TemplateGroup.__init__"></a> 426 <a NAME="TemplateGroup.__init__" ID="TemplateGroup.__init__"></a>
329 <h4>TemplateGroup (Constructor)</h4> 427 <h4>TemplateGroup (Constructor)</h4>
330 <b>TemplateGroup</b>(<i>parent, name, language="All"</i>) 428 <b>TemplateGroup</b>(<i>parent, name, language="All"</i>)
429
331 <p> 430 <p>
332 Constructor 431 Constructor
333 </p><dl> 432 </p>
433 <dl>
434
334 <dt><i>parent</i></dt> 435 <dt><i>parent</i></dt>
335 <dd> 436 <dd>
336 parent widget of the template group (QWidget) 437 parent widget of the template group (QWidget)
337 </dd><dt><i>name</i></dt> 438 </dd>
439 <dt><i>name</i></dt>
338 <dd> 440 <dd>
339 name of the group (string) 441 name of the group (string)
340 </dd><dt><i>language</i></dt> 442 </dd>
443 <dt><i>language</i></dt>
341 <dd> 444 <dd>
342 programming language for the group (string) 445 programming language for the group (string)
343 </dd> 446 </dd>
344 </dl><a NAME="TemplateGroup.addEntry" ID="TemplateGroup.addEntry"></a> 447 </dl>
448 <a NAME="TemplateGroup.addEntry" ID="TemplateGroup.addEntry"></a>
345 <h4>TemplateGroup.addEntry</h4> 449 <h4>TemplateGroup.addEntry</h4>
346 <b>addEntry</b>(<i>name, description, template, quiet=False</i>) 450 <b>addEntry</b>(<i>name, description, template, quiet=False</i>)
451
347 <p> 452 <p>
348 Public method to add a template entry to this group. 453 Public method to add a template entry to this group.
349 </p><dl> 454 </p>
455 <dl>
456
350 <dt><i>name</i></dt> 457 <dt><i>name</i></dt>
351 <dd> 458 <dd>
352 name of the entry (string) 459 name of the entry (string)
353 </dd><dt><i>description</i></dt> 460 </dd>
461 <dt><i>description</i></dt>
354 <dd> 462 <dd>
355 description of the entry to add (string) 463 description of the entry to add (string)
356 </dd><dt><i>template</i></dt> 464 </dd>
465 <dt><i>template</i></dt>
357 <dd> 466 <dd>
358 template text of the entry (string) 467 template text of the entry (string)
359 </dd><dt><i>quiet</i></dt> 468 </dd>
469 <dt><i>quiet</i></dt>
360 <dd> 470 <dd>
361 flag indicating quiet operation (boolean) 471 flag indicating quiet operation (boolean)
362 </dd> 472 </dd>
363 </dl><a NAME="TemplateGroup.getAllEntries" ID="TemplateGroup.getAllEntries"></a> 473 </dl>
474 <a NAME="TemplateGroup.getAllEntries" ID="TemplateGroup.getAllEntries"></a>
364 <h4>TemplateGroup.getAllEntries</h4> 475 <h4>TemplateGroup.getAllEntries</h4>
365 <b>getAllEntries</b>(<i></i>) 476 <b>getAllEntries</b>(<i></i>)
477
366 <p> 478 <p>
367 Public method to retrieve all entries. 479 Public method to retrieve all entries.
368 </p><dl> 480 </p>
481 <dl>
369 <dt>Returns:</dt> 482 <dt>Returns:</dt>
370 <dd> 483 <dd>
371 list of all entries (list of TemplateEntry) 484 list of all entries (list of TemplateEntry)
372 </dd> 485 </dd>
373 </dl><a NAME="TemplateGroup.getEntry" ID="TemplateGroup.getEntry"></a> 486 </dl>
487 <a NAME="TemplateGroup.getEntry" ID="TemplateGroup.getEntry"></a>
374 <h4>TemplateGroup.getEntry</h4> 488 <h4>TemplateGroup.getEntry</h4>
375 <b>getEntry</b>(<i>name</i>) 489 <b>getEntry</b>(<i>name</i>)
490
376 <p> 491 <p>
377 Public method to get an entry. 492 Public method to get an entry.
378 </p><dl> 493 </p>
494 <dl>
495
379 <dt><i>name</i></dt> 496 <dt><i>name</i></dt>
380 <dd> 497 <dd>
381 name of the entry to retrieve (string) 498 name of the entry to retrieve (string)
382 </dd> 499 </dd>
383 </dl><dl> 500 </dl>
501 <dl>
384 <dt>Returns:</dt> 502 <dt>Returns:</dt>
385 <dd> 503 <dd>
386 reference to the entry (TemplateEntry) 504 reference to the entry (TemplateEntry)
387 </dd> 505 </dd>
388 </dl><a NAME="TemplateGroup.getEntryNames" ID="TemplateGroup.getEntryNames"></a> 506 </dl>
507 <a NAME="TemplateGroup.getEntryNames" ID="TemplateGroup.getEntryNames"></a>
389 <h4>TemplateGroup.getEntryNames</h4> 508 <h4>TemplateGroup.getEntryNames</h4>
390 <b>getEntryNames</b>(<i>beginning</i>) 509 <b>getEntryNames</b>(<i>beginning</i>)
510
391 <p> 511 <p>
392 Public method to get the names of all entries, who's name starts with 512 Public method to get the names of all entries, who's name starts with
393 the given string. 513 the given string.
394 </p><dl> 514 </p>
515 <dl>
516
395 <dt><i>beginning</i></dt> 517 <dt><i>beginning</i></dt>
396 <dd> 518 <dd>
397 string denoting the beginning of the template name 519 string denoting the beginning of the template name
398 (string) 520 (string)
399 </dd> 521 </dd>
400 </dl><dl> 522 </dl>
523 <dl>
401 <dt>Returns:</dt> 524 <dt>Returns:</dt>
402 <dd> 525 <dd>
403 list of entry names found (list of strings) 526 list of entry names found (list of strings)
404 </dd> 527 </dd>
405 </dl><a NAME="TemplateGroup.getLanguage" ID="TemplateGroup.getLanguage"></a> 528 </dl>
529 <a NAME="TemplateGroup.getLanguage" ID="TemplateGroup.getLanguage"></a>
406 <h4>TemplateGroup.getLanguage</h4> 530 <h4>TemplateGroup.getLanguage</h4>
407 <b>getLanguage</b>(<i></i>) 531 <b>getLanguage</b>(<i></i>)
532
408 <p> 533 <p>
409 Public method to get the name of the group. 534 Public method to get the name of the group.
410 </p><dl> 535 </p>
536 <dl>
411 <dt>Returns:</dt> 537 <dt>Returns:</dt>
412 <dd> 538 <dd>
413 language of the group (string) 539 language of the group (string)
414 </dd> 540 </dd>
415 </dl><a NAME="TemplateGroup.getName" ID="TemplateGroup.getName"></a> 541 </dl>
542 <a NAME="TemplateGroup.getName" ID="TemplateGroup.getName"></a>
416 <h4>TemplateGroup.getName</h4> 543 <h4>TemplateGroup.getName</h4>
417 <b>getName</b>(<i></i>) 544 <b>getName</b>(<i></i>)
545
418 <p> 546 <p>
419 Public method to get the name of the group. 547 Public method to get the name of the group.
420 </p><dl> 548 </p>
549 <dl>
421 <dt>Returns:</dt> 550 <dt>Returns:</dt>
422 <dd> 551 <dd>
423 name of the group (string) 552 name of the group (string)
424 </dd> 553 </dd>
425 </dl><a NAME="TemplateGroup.hasEntry" ID="TemplateGroup.hasEntry"></a> 554 </dl>
555 <a NAME="TemplateGroup.hasEntry" ID="TemplateGroup.hasEntry"></a>
426 <h4>TemplateGroup.hasEntry</h4> 556 <h4>TemplateGroup.hasEntry</h4>
427 <b>hasEntry</b>(<i>name</i>) 557 <b>hasEntry</b>(<i>name</i>)
558
428 <p> 559 <p>
429 Public method to check, if the group has an entry with the given name. 560 Public method to check, if the group has an entry with the given name.
430 </p><dl> 561 </p>
562 <dl>
563
431 <dt><i>name</i></dt> 564 <dt><i>name</i></dt>
432 <dd> 565 <dd>
433 name of the entry to check for (string) 566 name of the entry to check for (string)
434 </dd> 567 </dd>
435 </dl><dl> 568 </dl>
569 <dl>
436 <dt>Returns:</dt> 570 <dt>Returns:</dt>
437 <dd> 571 <dd>
438 flag indicating existence (boolean) 572 flag indicating existence (boolean)
439 </dd> 573 </dd>
440 </dl><a NAME="TemplateGroup.removeAllEntries" ID="TemplateGroup.removeAllEntries"></a> 574 </dl>
575 <a NAME="TemplateGroup.removeAllEntries" ID="TemplateGroup.removeAllEntries"></a>
441 <h4>TemplateGroup.removeAllEntries</h4> 576 <h4>TemplateGroup.removeAllEntries</h4>
442 <b>removeAllEntries</b>(<i></i>) 577 <b>removeAllEntries</b>(<i></i>)
578
443 <p> 579 <p>
444 Public method to remove all template entries of this group. 580 Public method to remove all template entries of this group.
445 </p><a NAME="TemplateGroup.removeEntry" ID="TemplateGroup.removeEntry"></a> 581 </p>
582 <a NAME="TemplateGroup.removeEntry" ID="TemplateGroup.removeEntry"></a>
446 <h4>TemplateGroup.removeEntry</h4> 583 <h4>TemplateGroup.removeEntry</h4>
447 <b>removeEntry</b>(<i>name</i>) 584 <b>removeEntry</b>(<i>name</i>)
585
448 <p> 586 <p>
449 Public method to remove a template entry from this group. 587 Public method to remove a template entry from this group.
450 </p><dl> 588 </p>
589 <dl>
590
451 <dt><i>name</i></dt> 591 <dt><i>name</i></dt>
452 <dd> 592 <dd>
453 name of the entry to be removed (string) 593 name of the entry to be removed (string)
454 </dd> 594 </dd>
455 </dl><a NAME="TemplateGroup.setLanguage" ID="TemplateGroup.setLanguage"></a> 595 </dl>
596 <a NAME="TemplateGroup.setLanguage" ID="TemplateGroup.setLanguage"></a>
456 <h4>TemplateGroup.setLanguage</h4> 597 <h4>TemplateGroup.setLanguage</h4>
457 <b>setLanguage</b>(<i>language</i>) 598 <b>setLanguage</b>(<i>language</i>)
599
458 <p> 600 <p>
459 Public method to update the name of the group. 601 Public method to update the name of the group.
460 </p><dl> 602 </p>
603 <dl>
604
461 <dt><i>language</i></dt> 605 <dt><i>language</i></dt>
462 <dd> 606 <dd>
463 programming language for the group (string) 607 programming language for the group (string)
464 </dd> 608 </dd>
465 </dl><a NAME="TemplateGroup.setName" ID="TemplateGroup.setName"></a> 609 </dl>
610 <a NAME="TemplateGroup.setName" ID="TemplateGroup.setName"></a>
466 <h4>TemplateGroup.setName</h4> 611 <h4>TemplateGroup.setName</h4>
467 <b>setName</b>(<i>name</i>) 612 <b>setName</b>(<i>name</i>)
613
468 <p> 614 <p>
469 Public method to update the name of the group. 615 Public method to update the name of the group.
470 </p><dl> 616 </p>
617 <dl>
618
471 <dt><i>name</i></dt> 619 <dt><i>name</i></dt>
472 <dd> 620 <dd>
473 name of the group (string) 621 name of the group (string)
474 </dd> 622 </dd>
475 </dl> 623 </dl>
476 <div align="right"><a href="#top">Up</a></div> 624 <div align="right"><a href="#top">Up</a></div>
477 <hr /><hr /> 625 <hr />
626 <hr />
478 <a NAME="TemplateViewer" ID="TemplateViewer"></a> 627 <a NAME="TemplateViewer" ID="TemplateViewer"></a>
479 <h2>TemplateViewer</h2> 628 <h2>TemplateViewer</h2>
629
480 <p> 630 <p>
481 Class implementing the template viewer. 631 Class implementing the template viewer.
482 </p> 632 </p>
483 <h3>Derived from</h3> 633 <h3>Derived from</h3>
484 QTreeWidget 634 QTreeWidget
485 <h3>Class Attributes</h3> 635 <h3>Class Attributes</h3>
636
486 <table> 637 <table>
487 <tr><td>None</td></tr> 638 <tr><td>None</td></tr>
488 </table> 639 </table>
489 <h3>Class Methods</h3> 640 <h3>Class Methods</h3>
641
490 <table> 642 <table>
491 <tr><td>None</td></tr> 643 <tr><td>None</td></tr>
492 </table> 644 </table>
493 <h3>Methods</h3> 645 <h3>Methods</h3>
494 <table> 646
647 <table>
648
495 <tr> 649 <tr>
496 <td><a href="#TemplateViewer.__init__">TemplateViewer</a></td> 650 <td><a href="#TemplateViewer.__init__">TemplateViewer</a></td>
497 <td>Constructor</td> 651 <td>Constructor</td>
498 </tr><tr> 652 </tr>
653 <tr>
499 <td><a href="#TemplateViewer.__addEntry">__addEntry</a></td> 654 <td><a href="#TemplateViewer.__addEntry">__addEntry</a></td>
500 <td>Private slot to handle the Add Entry context menu action.</td> 655 <td>Private slot to handle the Add Entry context menu action.</td>
501 </tr><tr> 656 </tr>
657 <tr>
502 <td><a href="#TemplateViewer.__addGroup">__addGroup</a></td> 658 <td><a href="#TemplateViewer.__addGroup">__addGroup</a></td>
503 <td>Private slot to handle the Add Group context menu action.</td> 659 <td>Private slot to handle the Add Group context menu action.</td>
504 </tr><tr> 660 </tr>
661 <tr>
505 <td><a href="#TemplateViewer.__configure">__configure</a></td> 662 <td><a href="#TemplateViewer.__configure">__configure</a></td>
506 <td>Private method to open the configuration dialog.</td> 663 <td>Private method to open the configuration dialog.</td>
507 </tr><tr> 664 </tr>
665 <tr>
508 <td><a href="#TemplateViewer.__edit">__edit</a></td> 666 <td><a href="#TemplateViewer.__edit">__edit</a></td>
509 <td>Private slot to handle the Edit context menu action.</td> 667 <td>Private slot to handle the Edit context menu action.</td>
510 </tr><tr> 668 </tr>
669 <tr>
511 <td><a href="#TemplateViewer.__export">__export</a></td> 670 <td><a href="#TemplateViewer.__export">__export</a></td>
512 <td>Private slot to handle the Export context menu action.</td> 671 <td>Private slot to handle the Export context menu action.</td>
513 </tr><tr> 672 </tr>
673 <tr>
514 <td><a href="#TemplateViewer.__getPredefinedVars">__getPredefinedVars</a></td> 674 <td><a href="#TemplateViewer.__getPredefinedVars">__getPredefinedVars</a></td>
515 <td>Private method to return predefined variables.</td> 675 <td>Private method to return predefined variables.</td>
516 </tr><tr> 676 </tr>
677 <tr>
517 <td><a href="#TemplateViewer.__import">__import</a></td> 678 <td><a href="#TemplateViewer.__import">__import</a></td>
518 <td>Private slot to handle the Import context menu action.</td> 679 <td>Private slot to handle the Import context menu action.</td>
519 </tr><tr> 680 </tr>
681 <tr>
520 <td><a href="#TemplateViewer.__reload">__reload</a></td> 682 <td><a href="#TemplateViewer.__reload">__reload</a></td>
521 <td>Private slot to reload the templates.</td> 683 <td>Private slot to reload the templates.</td>
522 </tr><tr> 684 </tr>
685 <tr>
523 <td><a href="#TemplateViewer.__remove">__remove</a></td> 686 <td><a href="#TemplateViewer.__remove">__remove</a></td>
524 <td>Private slot to handle the Remove context menu action.</td> 687 <td>Private slot to handle the Remove context menu action.</td>
525 </tr><tr> 688 </tr>
689 <tr>
526 <td><a href="#TemplateViewer.__resort">__resort</a></td> 690 <td><a href="#TemplateViewer.__resort">__resort</a></td>
527 <td>Private method to resort the tree.</td> 691 <td>Private method to resort the tree.</td>
528 </tr><tr> 692 </tr>
693 <tr>
529 <td><a href="#TemplateViewer.__showContextMenu">__showContextMenu</a></td> 694 <td><a href="#TemplateViewer.__showContextMenu">__showContextMenu</a></td>
530 <td>Private slot to show the context menu of the list.</td> 695 <td>Private slot to show the context menu of the list.</td>
531 </tr><tr> 696 </tr>
697 <tr>
532 <td><a href="#TemplateViewer.__showHelp">__showHelp</a></td> 698 <td><a href="#TemplateViewer.__showHelp">__showHelp</a></td>
533 <td>Private method to show some help.</td> 699 <td>Private method to show some help.</td>
534 </tr><tr> 700 </tr>
701 <tr>
535 <td><a href="#TemplateViewer.__templateItemActivated">__templateItemActivated</a></td> 702 <td><a href="#TemplateViewer.__templateItemActivated">__templateItemActivated</a></td>
536 <td>Private slot to handle the activation of an item.</td> 703 <td>Private slot to handle the activation of an item.</td>
537 </tr><tr> 704 </tr>
705 <tr>
538 <td><a href="#TemplateViewer.addEntry">addEntry</a></td> 706 <td><a href="#TemplateViewer.addEntry">addEntry</a></td>
539 <td>Public method to add a template entry.</td> 707 <td>Public method to add a template entry.</td>
540 </tr><tr> 708 </tr>
709 <tr>
541 <td><a href="#TemplateViewer.addGroup">addGroup</a></td> 710 <td><a href="#TemplateViewer.addGroup">addGroup</a></td>
542 <td>Public method to add a group.</td> 711 <td>Public method to add a group.</td>
543 </tr><tr> 712 </tr>
713 <tr>
544 <td><a href="#TemplateViewer.applyNamedTemplate">applyNamedTemplate</a></td> 714 <td><a href="#TemplateViewer.applyNamedTemplate">applyNamedTemplate</a></td>
545 <td>Public method to apply a template given a template name.</td> 715 <td>Public method to apply a template given a template name.</td>
546 </tr><tr> 716 </tr>
717 <tr>
547 <td><a href="#TemplateViewer.applyTemplate">applyTemplate</a></td> 718 <td><a href="#TemplateViewer.applyTemplate">applyTemplate</a></td>
548 <td>Public method to apply the template.</td> 719 <td>Public method to apply the template.</td>
549 </tr><tr> 720 </tr>
721 <tr>
550 <td><a href="#TemplateViewer.changeEntry">changeEntry</a></td> 722 <td><a href="#TemplateViewer.changeEntry">changeEntry</a></td>
551 <td>Public method to change a template entry.</td> 723 <td>Public method to change a template entry.</td>
552 </tr><tr> 724 </tr>
725 <tr>
553 <td><a href="#TemplateViewer.changeGroup">changeGroup</a></td> 726 <td><a href="#TemplateViewer.changeGroup">changeGroup</a></td>
554 <td>Public method to rename a group.</td> 727 <td>Public method to rename a group.</td>
555 </tr><tr> 728 </tr>
729 <tr>
556 <td><a href="#TemplateViewer.getAllGroups">getAllGroups</a></td> 730 <td><a href="#TemplateViewer.getAllGroups">getAllGroups</a></td>
557 <td>Public method to get all groups.</td> 731 <td>Public method to get all groups.</td>
558 </tr><tr> 732 </tr>
733 <tr>
559 <td><a href="#TemplateViewer.getGroupNames">getGroupNames</a></td> 734 <td><a href="#TemplateViewer.getGroupNames">getGroupNames</a></td>
560 <td>Public method to get all group names.</td> 735 <td>Public method to get all group names.</td>
561 </tr><tr> 736 </tr>
737 <tr>
562 <td><a href="#TemplateViewer.getTemplateNames">getTemplateNames</a></td> 738 <td><a href="#TemplateViewer.getTemplateNames">getTemplateNames</a></td>
563 <td>Public method to get the names of templates starting with the given string.</td> 739 <td>Public method to get the names of templates starting with the given string.</td>
564 </tr><tr> 740 </tr>
741 <tr>
565 <td><a href="#TemplateViewer.hasGroup">hasGroup</a></td> 742 <td><a href="#TemplateViewer.hasGroup">hasGroup</a></td>
566 <td>Public method to check, if a group with the given name exists.</td> 743 <td>Public method to check, if a group with the given name exists.</td>
567 </tr><tr> 744 </tr>
745 <tr>
568 <td><a href="#TemplateViewer.hasTemplate">hasTemplate</a></td> 746 <td><a href="#TemplateViewer.hasTemplate">hasTemplate</a></td>
569 <td>Public method to check, if an entry of the given name exists.</td> 747 <td>Public method to check, if an entry of the given name exists.</td>
570 </tr><tr> 748 </tr>
749 <tr>
571 <td><a href="#TemplateViewer.readTemplates">readTemplates</a></td> 750 <td><a href="#TemplateViewer.readTemplates">readTemplates</a></td>
572 <td>Public method to read in the templates file (.e4c).</td> 751 <td>Public method to read in the templates file (.e4c).</td>
573 </tr><tr> 752 </tr>
753 <tr>
574 <td><a href="#TemplateViewer.removeEntry">removeEntry</a></td> 754 <td><a href="#TemplateViewer.removeEntry">removeEntry</a></td>
575 <td>Public method to remove a template entry.</td> 755 <td>Public method to remove a template entry.</td>
576 </tr><tr> 756 </tr>
757 <tr>
577 <td><a href="#TemplateViewer.removeGroup">removeGroup</a></td> 758 <td><a href="#TemplateViewer.removeGroup">removeGroup</a></td>
578 <td>Public method to remove a group.</td> 759 <td>Public method to remove a group.</td>
579 </tr><tr> 760 </tr>
761 <tr>
580 <td><a href="#TemplateViewer.save">save</a></td> 762 <td><a href="#TemplateViewer.save">save</a></td>
581 <td>Public slot to save the templates.</td> 763 <td>Public slot to save the templates.</td>
582 </tr><tr> 764 </tr>
765 <tr>
583 <td><a href="#TemplateViewer.writeTemplates">writeTemplates</a></td> 766 <td><a href="#TemplateViewer.writeTemplates">writeTemplates</a></td>
584 <td>Public method to write the templates data to an XML file (.e4c).</td> 767 <td>Public method to write the templates data to an XML file (.e4c).</td>
585 </tr> 768 </tr>
586 </table> 769 </table>
587 <h3>Static Methods</h3> 770 <h3>Static Methods</h3>
771
588 <table> 772 <table>
589 <tr><td>None</td></tr> 773 <tr><td>None</td></tr>
590 </table> 774 </table>
775
591 <a NAME="TemplateViewer.__init__" ID="TemplateViewer.__init__"></a> 776 <a NAME="TemplateViewer.__init__" ID="TemplateViewer.__init__"></a>
592 <h4>TemplateViewer (Constructor)</h4> 777 <h4>TemplateViewer (Constructor)</h4>
593 <b>TemplateViewer</b>(<i>parent, viewmanager</i>) 778 <b>TemplateViewer</b>(<i>parent, viewmanager</i>)
779
594 <p> 780 <p>
595 Constructor 781 Constructor
596 </p><dl> 782 </p>
783 <dl>
784
597 <dt><i>parent</i></dt> 785 <dt><i>parent</i></dt>
598 <dd> 786 <dd>
599 the parent (QWidget) 787 the parent (QWidget)
600 </dd><dt><i>viewmanager</i></dt> 788 </dd>
789 <dt><i>viewmanager</i></dt>
601 <dd> 790 <dd>
602 reference to the viewmanager object 791 reference to the viewmanager object
603 </dd> 792 </dd>
604 </dl><a NAME="TemplateViewer.__addEntry" ID="TemplateViewer.__addEntry"></a> 793 </dl>
794 <a NAME="TemplateViewer.__addEntry" ID="TemplateViewer.__addEntry"></a>
605 <h4>TemplateViewer.__addEntry</h4> 795 <h4>TemplateViewer.__addEntry</h4>
606 <b>__addEntry</b>(<i></i>) 796 <b>__addEntry</b>(<i></i>)
797
607 <p> 798 <p>
608 Private slot to handle the Add Entry context menu action. 799 Private slot to handle the Add Entry context menu action.
609 </p><a NAME="TemplateViewer.__addGroup" ID="TemplateViewer.__addGroup"></a> 800 </p>
801 <a NAME="TemplateViewer.__addGroup" ID="TemplateViewer.__addGroup"></a>
610 <h4>TemplateViewer.__addGroup</h4> 802 <h4>TemplateViewer.__addGroup</h4>
611 <b>__addGroup</b>(<i></i>) 803 <b>__addGroup</b>(<i></i>)
804
612 <p> 805 <p>
613 Private slot to handle the Add Group context menu action. 806 Private slot to handle the Add Group context menu action.
614 </p><a NAME="TemplateViewer.__configure" ID="TemplateViewer.__configure"></a> 807 </p>
808 <a NAME="TemplateViewer.__configure" ID="TemplateViewer.__configure"></a>
615 <h4>TemplateViewer.__configure</h4> 809 <h4>TemplateViewer.__configure</h4>
616 <b>__configure</b>(<i></i>) 810 <b>__configure</b>(<i></i>)
811
617 <p> 812 <p>
618 Private method to open the configuration dialog. 813 Private method to open the configuration dialog.
619 </p><a NAME="TemplateViewer.__edit" ID="TemplateViewer.__edit"></a> 814 </p>
815 <a NAME="TemplateViewer.__edit" ID="TemplateViewer.__edit"></a>
620 <h4>TemplateViewer.__edit</h4> 816 <h4>TemplateViewer.__edit</h4>
621 <b>__edit</b>(<i></i>) 817 <b>__edit</b>(<i></i>)
818
622 <p> 819 <p>
623 Private slot to handle the Edit context menu action. 820 Private slot to handle the Edit context menu action.
624 </p><a NAME="TemplateViewer.__export" ID="TemplateViewer.__export"></a> 821 </p>
822 <a NAME="TemplateViewer.__export" ID="TemplateViewer.__export"></a>
625 <h4>TemplateViewer.__export</h4> 823 <h4>TemplateViewer.__export</h4>
626 <b>__export</b>(<i></i>) 824 <b>__export</b>(<i></i>)
825
627 <p> 826 <p>
628 Private slot to handle the Export context menu action. 827 Private slot to handle the Export context menu action.
629 </p><a NAME="TemplateViewer.__getPredefinedVars" ID="TemplateViewer.__getPredefinedVars"></a> 828 </p>
829 <a NAME="TemplateViewer.__getPredefinedVars" ID="TemplateViewer.__getPredefinedVars"></a>
630 <h4>TemplateViewer.__getPredefinedVars</h4> 830 <h4>TemplateViewer.__getPredefinedVars</h4>
631 <b>__getPredefinedVars</b>(<i></i>) 831 <b>__getPredefinedVars</b>(<i></i>)
832
632 <p> 833 <p>
633 Private method to return predefined variables. 834 Private method to return predefined variables.
634 </p><dl> 835 </p>
836 <dl>
635 <dt>Returns:</dt> 837 <dt>Returns:</dt>
636 <dd> 838 <dd>
637 dictionary of predefined variables and their values 839 dictionary of predefined variables and their values
638 </dd> 840 </dd>
639 </dl><a NAME="TemplateViewer.__import" ID="TemplateViewer.__import"></a> 841 </dl>
842 <a NAME="TemplateViewer.__import" ID="TemplateViewer.__import"></a>
640 <h4>TemplateViewer.__import</h4> 843 <h4>TemplateViewer.__import</h4>
641 <b>__import</b>(<i></i>) 844 <b>__import</b>(<i></i>)
845
642 <p> 846 <p>
643 Private slot to handle the Import context menu action. 847 Private slot to handle the Import context menu action.
644 </p><a NAME="TemplateViewer.__reload" ID="TemplateViewer.__reload"></a> 848 </p>
849 <a NAME="TemplateViewer.__reload" ID="TemplateViewer.__reload"></a>
645 <h4>TemplateViewer.__reload</h4> 850 <h4>TemplateViewer.__reload</h4>
646 <b>__reload</b>(<i></i>) 851 <b>__reload</b>(<i></i>)
852
647 <p> 853 <p>
648 Private slot to reload the templates. 854 Private slot to reload the templates.
649 </p><a NAME="TemplateViewer.__remove" ID="TemplateViewer.__remove"></a> 855 </p>
856 <a NAME="TemplateViewer.__remove" ID="TemplateViewer.__remove"></a>
650 <h4>TemplateViewer.__remove</h4> 857 <h4>TemplateViewer.__remove</h4>
651 <b>__remove</b>(<i></i>) 858 <b>__remove</b>(<i></i>)
859
652 <p> 860 <p>
653 Private slot to handle the Remove context menu action. 861 Private slot to handle the Remove context menu action.
654 </p><a NAME="TemplateViewer.__resort" ID="TemplateViewer.__resort"></a> 862 </p>
863 <a NAME="TemplateViewer.__resort" ID="TemplateViewer.__resort"></a>
655 <h4>TemplateViewer.__resort</h4> 864 <h4>TemplateViewer.__resort</h4>
656 <b>__resort</b>(<i></i>) 865 <b>__resort</b>(<i></i>)
866
657 <p> 867 <p>
658 Private method to resort the tree. 868 Private method to resort the tree.
659 </p><a NAME="TemplateViewer.__showContextMenu" ID="TemplateViewer.__showContextMenu"></a> 869 </p>
870 <a NAME="TemplateViewer.__showContextMenu" ID="TemplateViewer.__showContextMenu"></a>
660 <h4>TemplateViewer.__showContextMenu</h4> 871 <h4>TemplateViewer.__showContextMenu</h4>
661 <b>__showContextMenu</b>(<i>coord</i>) 872 <b>__showContextMenu</b>(<i>coord</i>)
873
662 <p> 874 <p>
663 Private slot to show the context menu of the list. 875 Private slot to show the context menu of the list.
664 </p><dl> 876 </p>
877 <dl>
878
665 <dt><i>coord</i></dt> 879 <dt><i>coord</i></dt>
666 <dd> 880 <dd>
667 the position of the mouse pointer (QPoint) 881 the position of the mouse pointer (QPoint)
668 </dd> 882 </dd>
669 </dl><a NAME="TemplateViewer.__showHelp" ID="TemplateViewer.__showHelp"></a> 883 </dl>
884 <a NAME="TemplateViewer.__showHelp" ID="TemplateViewer.__showHelp"></a>
670 <h4>TemplateViewer.__showHelp</h4> 885 <h4>TemplateViewer.__showHelp</h4>
671 <b>__showHelp</b>(<i></i>) 886 <b>__showHelp</b>(<i></i>)
887
672 <p> 888 <p>
673 Private method to show some help. 889 Private method to show some help.
674 </p><a NAME="TemplateViewer.__templateItemActivated" ID="TemplateViewer.__templateItemActivated"></a> 890 </p>
891 <a NAME="TemplateViewer.__templateItemActivated" ID="TemplateViewer.__templateItemActivated"></a>
675 <h4>TemplateViewer.__templateItemActivated</h4> 892 <h4>TemplateViewer.__templateItemActivated</h4>
676 <b>__templateItemActivated</b>(<i>itm=None, col=0</i>) 893 <b>__templateItemActivated</b>(<i>itm=None, col=0</i>)
894
677 <p> 895 <p>
678 Private slot to handle the activation of an item. 896 Private slot to handle the activation of an item.
679 </p><dl> 897 </p>
898 <dl>
899
680 <dt><i>itm</i></dt> 900 <dt><i>itm</i></dt>
681 <dd> 901 <dd>
682 reference to the activated item (QTreeWidgetItem) 902 reference to the activated item (QTreeWidgetItem)
683 </dd><dt><i>col</i></dt> 903 </dd>
904 <dt><i>col</i></dt>
684 <dd> 905 <dd>
685 column the item was activated in (integer) 906 column the item was activated in (integer)
686 </dd> 907 </dd>
687 </dl><a NAME="TemplateViewer.addEntry" ID="TemplateViewer.addEntry"></a> 908 </dl>
909 <a NAME="TemplateViewer.addEntry" ID="TemplateViewer.addEntry"></a>
688 <h4>TemplateViewer.addEntry</h4> 910 <h4>TemplateViewer.addEntry</h4>
689 <b>addEntry</b>(<i>groupName, name, description, template, quiet=False</i>) 911 <b>addEntry</b>(<i>groupName, name, description, template, quiet=False</i>)
912
690 <p> 913 <p>
691 Public method to add a template entry. 914 Public method to add a template entry.
692 </p><dl> 915 </p>
916 <dl>
917
693 <dt><i>groupName</i></dt> 918 <dt><i>groupName</i></dt>
694 <dd> 919 <dd>
695 name of the group to add to (string) 920 name of the group to add to (string)
696 </dd><dt><i>name</i></dt> 921 </dd>
922 <dt><i>name</i></dt>
697 <dd> 923 <dd>
698 name of the entry to add (string) 924 name of the entry to add (string)
699 </dd><dt><i>description</i></dt> 925 </dd>
926 <dt><i>description</i></dt>
700 <dd> 927 <dd>
701 description of the entry to add (string) 928 description of the entry to add (string)
702 </dd><dt><i>template</i></dt> 929 </dd>
930 <dt><i>template</i></dt>
703 <dd> 931 <dd>
704 template text of the entry (string) 932 template text of the entry (string)
705 </dd><dt><i>quiet</i></dt> 933 </dd>
934 <dt><i>quiet</i></dt>
706 <dd> 935 <dd>
707 flag indicating quiet operation (boolean) 936 flag indicating quiet operation (boolean)
708 </dd> 937 </dd>
709 </dl><a NAME="TemplateViewer.addGroup" ID="TemplateViewer.addGroup"></a> 938 </dl>
939 <a NAME="TemplateViewer.addGroup" ID="TemplateViewer.addGroup"></a>
710 <h4>TemplateViewer.addGroup</h4> 940 <h4>TemplateViewer.addGroup</h4>
711 <b>addGroup</b>(<i>name, language="All"</i>) 941 <b>addGroup</b>(<i>name, language="All"</i>)
942
712 <p> 943 <p>
713 Public method to add a group. 944 Public method to add a group.
714 </p><dl> 945 </p>
946 <dl>
947
715 <dt><i>name</i></dt> 948 <dt><i>name</i></dt>
716 <dd> 949 <dd>
717 name of the group to be added (string) 950 name of the group to be added (string)
718 </dd><dt><i>language</i></dt> 951 </dd>
952 <dt><i>language</i></dt>
719 <dd> 953 <dd>
720 programming language for the group (string) 954 programming language for the group (string)
721 </dd> 955 </dd>
722 </dl><a NAME="TemplateViewer.applyNamedTemplate" ID="TemplateViewer.applyNamedTemplate"></a> 956 </dl>
957 <a NAME="TemplateViewer.applyNamedTemplate" ID="TemplateViewer.applyNamedTemplate"></a>
723 <h4>TemplateViewer.applyNamedTemplate</h4> 958 <h4>TemplateViewer.applyNamedTemplate</h4>
724 <b>applyNamedTemplate</b>(<i>templateName, groupName=None</i>) 959 <b>applyNamedTemplate</b>(<i>templateName, groupName=None</i>)
960
725 <p> 961 <p>
726 Public method to apply a template given a template name. 962 Public method to apply a template given a template name.
727 </p><dl> 963 </p>
964 <dl>
965
728 <dt><i>templateName</i></dt> 966 <dt><i>templateName</i></dt>
729 <dd> 967 <dd>
730 name of the template item to apply (string) 968 name of the template item to apply (string)
731 </dd><dt><i>groupName</i></dt> 969 </dd>
970 <dt><i>groupName</i></dt>
732 <dd> 971 <dd>
733 name of the group to get the entry from (string). 972 name of the group to get the entry from (string).
734 None or empty means to apply the first template found with the 973 None or empty means to apply the first template found with the
735 given name. 974 given name.
736 </dd> 975 </dd>
737 </dl><a NAME="TemplateViewer.applyTemplate" ID="TemplateViewer.applyTemplate"></a> 976 </dl>
977 <a NAME="TemplateViewer.applyTemplate" ID="TemplateViewer.applyTemplate"></a>
738 <h4>TemplateViewer.applyTemplate</h4> 978 <h4>TemplateViewer.applyTemplate</h4>
739 <b>applyTemplate</b>(<i>itm</i>) 979 <b>applyTemplate</b>(<i>itm</i>)
980
740 <p> 981 <p>
741 Public method to apply the template. 982 Public method to apply the template.
742 </p><dl> 983 </p>
984 <dl>
985
743 <dt><i>itm</i></dt> 986 <dt><i>itm</i></dt>
744 <dd> 987 <dd>
745 reference to the template item to apply (TemplateEntry) 988 reference to the template item to apply (TemplateEntry)
746 </dd> 989 </dd>
747 </dl><a NAME="TemplateViewer.changeEntry" ID="TemplateViewer.changeEntry"></a> 990 </dl>
991 <a NAME="TemplateViewer.changeEntry" ID="TemplateViewer.changeEntry"></a>
748 <h4>TemplateViewer.changeEntry</h4> 992 <h4>TemplateViewer.changeEntry</h4>
749 <b>changeEntry</b>(<i>itm, name, groupName, description, template</i>) 993 <b>changeEntry</b>(<i>itm, name, groupName, description, template</i>)
994
750 <p> 995 <p>
751 Public method to change a template entry. 996 Public method to change a template entry.
752 </p><dl> 997 </p>
998 <dl>
999
753 <dt><i>itm</i></dt> 1000 <dt><i>itm</i></dt>
754 <dd> 1001 <dd>
755 template entry to be changed (TemplateEntry) 1002 template entry to be changed (TemplateEntry)
756 </dd><dt><i>name</i></dt> 1003 </dd>
1004 <dt><i>name</i></dt>
757 <dd> 1005 <dd>
758 new name for the entry (string) 1006 new name for the entry (string)
759 </dd><dt><i>groupName</i></dt> 1007 </dd>
1008 <dt><i>groupName</i></dt>
760 <dd> 1009 <dd>
761 name of the group the entry should belong to 1010 name of the group the entry should belong to
762 (string) 1011 (string)
763 </dd><dt><i>description</i></dt> 1012 </dd>
1013 <dt><i>description</i></dt>
764 <dd> 1014 <dd>
765 description of the entry (string) 1015 description of the entry (string)
766 </dd><dt><i>template</i></dt> 1016 </dd>
1017 <dt><i>template</i></dt>
767 <dd> 1018 <dd>
768 template text of the entry (string) 1019 template text of the entry (string)
769 </dd> 1020 </dd>
770 </dl><a NAME="TemplateViewer.changeGroup" ID="TemplateViewer.changeGroup"></a> 1021 </dl>
1022 <a NAME="TemplateViewer.changeGroup" ID="TemplateViewer.changeGroup"></a>
771 <h4>TemplateViewer.changeGroup</h4> 1023 <h4>TemplateViewer.changeGroup</h4>
772 <b>changeGroup</b>(<i>oldname, newname, language="All"</i>) 1024 <b>changeGroup</b>(<i>oldname, newname, language="All"</i>)
1025
773 <p> 1026 <p>
774 Public method to rename a group. 1027 Public method to rename a group.
775 </p><dl> 1028 </p>
1029 <dl>
1030
776 <dt><i>oldname</i></dt> 1031 <dt><i>oldname</i></dt>
777 <dd> 1032 <dd>
778 old name of the group (string) 1033 old name of the group (string)
779 </dd><dt><i>newname</i></dt> 1034 </dd>
1035 <dt><i>newname</i></dt>
780 <dd> 1036 <dd>
781 new name of the group (string) 1037 new name of the group (string)
782 </dd><dt><i>language</i></dt> 1038 </dd>
1039 <dt><i>language</i></dt>
783 <dd> 1040 <dd>
784 programming language for the group (string) 1041 programming language for the group (string)
785 </dd> 1042 </dd>
786 </dl><a NAME="TemplateViewer.getAllGroups" ID="TemplateViewer.getAllGroups"></a> 1043 </dl>
1044 <a NAME="TemplateViewer.getAllGroups" ID="TemplateViewer.getAllGroups"></a>
787 <h4>TemplateViewer.getAllGroups</h4> 1045 <h4>TemplateViewer.getAllGroups</h4>
788 <b>getAllGroups</b>(<i></i>) 1046 <b>getAllGroups</b>(<i></i>)
1047
789 <p> 1048 <p>
790 Public method to get all groups. 1049 Public method to get all groups.
791 </p><dl> 1050 </p>
1051 <dl>
792 <dt>Returns:</dt> 1052 <dt>Returns:</dt>
793 <dd> 1053 <dd>
794 list of all groups (list of TemplateGroup) 1054 list of all groups (list of TemplateGroup)
795 </dd> 1055 </dd>
796 </dl><a NAME="TemplateViewer.getGroupNames" ID="TemplateViewer.getGroupNames"></a> 1056 </dl>
1057 <a NAME="TemplateViewer.getGroupNames" ID="TemplateViewer.getGroupNames"></a>
797 <h4>TemplateViewer.getGroupNames</h4> 1058 <h4>TemplateViewer.getGroupNames</h4>
798 <b>getGroupNames</b>(<i></i>) 1059 <b>getGroupNames</b>(<i></i>)
1060
799 <p> 1061 <p>
800 Public method to get all group names. 1062 Public method to get all group names.
801 </p><dl> 1063 </p>
1064 <dl>
802 <dt>Returns:</dt> 1065 <dt>Returns:</dt>
803 <dd> 1066 <dd>
804 list of all group names (list of strings) 1067 list of all group names (list of strings)
805 </dd> 1068 </dd>
806 </dl><a NAME="TemplateViewer.getTemplateNames" ID="TemplateViewer.getTemplateNames"></a> 1069 </dl>
1070 <a NAME="TemplateViewer.getTemplateNames" ID="TemplateViewer.getTemplateNames"></a>
807 <h4>TemplateViewer.getTemplateNames</h4> 1071 <h4>TemplateViewer.getTemplateNames</h4>
808 <b>getTemplateNames</b>(<i>start, groupName=None</i>) 1072 <b>getTemplateNames</b>(<i>start, groupName=None</i>)
1073
809 <p> 1074 <p>
810 Public method to get the names of templates starting with the 1075 Public method to get the names of templates starting with the
811 given string. 1076 given string.
812 </p><dl> 1077 </p>
1078 <dl>
1079
813 <dt><i>start</i></dt> 1080 <dt><i>start</i></dt>
814 <dd> 1081 <dd>
815 start string of the name (string) 1082 start string of the name (string)
816 </dd><dt><i>groupName</i></dt> 1083 </dd>
1084 <dt><i>groupName</i></dt>
817 <dd> 1085 <dd>
818 name of the group to get the entry from (string). 1086 name of the group to get the entry from (string).
819 None or empty means to look in all groups. 1087 None or empty means to look in all groups.
820 </dd> 1088 </dd>
821 </dl><dl> 1089 </dl>
1090 <dl>
822 <dt>Returns:</dt> 1091 <dt>Returns:</dt>
823 <dd> 1092 <dd>
824 sorted list of matching template names (list of strings) 1093 sorted list of matching template names (list of strings)
825 </dd> 1094 </dd>
826 </dl><a NAME="TemplateViewer.hasGroup" ID="TemplateViewer.hasGroup"></a> 1095 </dl>
1096 <a NAME="TemplateViewer.hasGroup" ID="TemplateViewer.hasGroup"></a>
827 <h4>TemplateViewer.hasGroup</h4> 1097 <h4>TemplateViewer.hasGroup</h4>
828 <b>hasGroup</b>(<i>name</i>) 1098 <b>hasGroup</b>(<i>name</i>)
1099
829 <p> 1100 <p>
830 Public method to check, if a group with the given name exists. 1101 Public method to check, if a group with the given name exists.
831 </p><dl> 1102 </p>
1103 <dl>
1104
832 <dt><i>name</i></dt> 1105 <dt><i>name</i></dt>
833 <dd> 1106 <dd>
834 name of the group to be checked for (string) 1107 name of the group to be checked for (string)
835 </dd> 1108 </dd>
836 </dl><dl> 1109 </dl>
1110 <dl>
837 <dt>Returns:</dt> 1111 <dt>Returns:</dt>
838 <dd> 1112 <dd>
839 flag indicating an existing group (boolean) 1113 flag indicating an existing group (boolean)
840 </dd> 1114 </dd>
841 </dl><a NAME="TemplateViewer.hasTemplate" ID="TemplateViewer.hasTemplate"></a> 1115 </dl>
1116 <a NAME="TemplateViewer.hasTemplate" ID="TemplateViewer.hasTemplate"></a>
842 <h4>TemplateViewer.hasTemplate</h4> 1117 <h4>TemplateViewer.hasTemplate</h4>
843 <b>hasTemplate</b>(<i>entryName, groupName=None</i>) 1118 <b>hasTemplate</b>(<i>entryName, groupName=None</i>)
1119
844 <p> 1120 <p>
845 Public method to check, if an entry of the given name exists. 1121 Public method to check, if an entry of the given name exists.
846 </p><dl> 1122 </p>
1123 <dl>
1124
847 <dt><i>entryName</i></dt> 1125 <dt><i>entryName</i></dt>
848 <dd> 1126 <dd>
849 name of the entry to check for (string) 1127 name of the entry to check for (string)
850 </dd><dt><i>groupName</i></dt> 1128 </dd>
1129 <dt><i>groupName</i></dt>
851 <dd> 1130 <dd>
852 name of the group to check for the entry (string). 1131 name of the group to check for the entry (string).
853 None or empty means to check all groups. 1132 None or empty means to check all groups.
854 </dd> 1133 </dd>
855 </dl><dl> 1134 </dl>
1135 <dl>
856 <dt>Returns:</dt> 1136 <dt>Returns:</dt>
857 <dd> 1137 <dd>
858 flag indicating the existence (boolean) 1138 flag indicating the existence (boolean)
859 </dd> 1139 </dd>
860 </dl><a NAME="TemplateViewer.readTemplates" ID="TemplateViewer.readTemplates"></a> 1140 </dl>
1141 <a NAME="TemplateViewer.readTemplates" ID="TemplateViewer.readTemplates"></a>
861 <h4>TemplateViewer.readTemplates</h4> 1142 <h4>TemplateViewer.readTemplates</h4>
862 <b>readTemplates</b>(<i>filename=None</i>) 1143 <b>readTemplates</b>(<i>filename=None</i>)
1144
863 <p> 1145 <p>
864 Public method to read in the templates file (.e4c). 1146 Public method to read in the templates file (.e4c).
865 </p><dl> 1147 </p>
1148 <dl>
1149
866 <dt><i>filename</i></dt> 1150 <dt><i>filename</i></dt>
867 <dd> 1151 <dd>
868 name of a templates file to read (string) 1152 name of a templates file to read (string)
869 </dd> 1153 </dd>
870 </dl><a NAME="TemplateViewer.removeEntry" ID="TemplateViewer.removeEntry"></a> 1154 </dl>
1155 <a NAME="TemplateViewer.removeEntry" ID="TemplateViewer.removeEntry"></a>
871 <h4>TemplateViewer.removeEntry</h4> 1156 <h4>TemplateViewer.removeEntry</h4>
872 <b>removeEntry</b>(<i>itm</i>) 1157 <b>removeEntry</b>(<i>itm</i>)
1158
873 <p> 1159 <p>
874 Public method to remove a template entry. 1160 Public method to remove a template entry.
875 </p><dl> 1161 </p>
1162 <dl>
1163
876 <dt><i>itm</i></dt> 1164 <dt><i>itm</i></dt>
877 <dd> 1165 <dd>
878 template entry to be removed (TemplateEntry) 1166 template entry to be removed (TemplateEntry)
879 </dd> 1167 </dd>
880 </dl><a NAME="TemplateViewer.removeGroup" ID="TemplateViewer.removeGroup"></a> 1168 </dl>
1169 <a NAME="TemplateViewer.removeGroup" ID="TemplateViewer.removeGroup"></a>
881 <h4>TemplateViewer.removeGroup</h4> 1170 <h4>TemplateViewer.removeGroup</h4>
882 <b>removeGroup</b>(<i>itm</i>) 1171 <b>removeGroup</b>(<i>itm</i>)
1172
883 <p> 1173 <p>
884 Public method to remove a group. 1174 Public method to remove a group.
885 </p><dl> 1175 </p>
1176 <dl>
1177
886 <dt><i>itm</i></dt> 1178 <dt><i>itm</i></dt>
887 <dd> 1179 <dd>
888 template group to be removed (TemplateGroup) 1180 template group to be removed (TemplateGroup)
889 </dd> 1181 </dd>
890 </dl><a NAME="TemplateViewer.save" ID="TemplateViewer.save"></a> 1182 </dl>
1183 <a NAME="TemplateViewer.save" ID="TemplateViewer.save"></a>
891 <h4>TemplateViewer.save</h4> 1184 <h4>TemplateViewer.save</h4>
892 <b>save</b>(<i></i>) 1185 <b>save</b>(<i></i>)
1186
893 <p> 1187 <p>
894 Public slot to save the templates. 1188 Public slot to save the templates.
895 </p><a NAME="TemplateViewer.writeTemplates" ID="TemplateViewer.writeTemplates"></a> 1189 </p>
1190 <a NAME="TemplateViewer.writeTemplates" ID="TemplateViewer.writeTemplates"></a>
896 <h4>TemplateViewer.writeTemplates</h4> 1191 <h4>TemplateViewer.writeTemplates</h4>
897 <b>writeTemplates</b>(<i>filename=None</i>) 1192 <b>writeTemplates</b>(<i>filename=None</i>)
1193
898 <p> 1194 <p>
899 Public method to write the templates data to an XML file (.e4c). 1195 Public method to write the templates data to an XML file (.e4c).
900 </p><dl> 1196 </p>
1197 <dl>
1198
901 <dt><i>filename</i></dt> 1199 <dt><i>filename</i></dt>
902 <dd> 1200 <dd>
903 name of a templates file to read (string) 1201 name of a templates file to read (string)
904 </dd> 1202 </dd>
905 </dl><dl> 1203 </dl>
1204 <dl>
906 <dt>Returns:</dt> 1205 <dt>Returns:</dt>
907 <dd> 1206 <dd>
908 flag indicating success (boolean) 1207 flag indicating success (boolean)
909 </dd> 1208 </dd>
910 </dl> 1209 </dl>

eric ide

mercurial