Mercurial Repositories > eric / file comparison

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

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

changeset 7989
a21d673a8f99
parent 7273
391d6b7b1eff
child 8049
af58c1d47e5e
equal deleted inserted replaced
7988:c4c17121eff8 7989:a21d673a8f99
167 167
168 <p> 168 <p>
169 Private method to generate the display text. 169 Private method to generate the display text.
170 </p> 170 </p>
171 <dl> 171 <dl>
172 <dt>Returns:</dt> 172 <dt>Return:</dt>
173 <dd> 173 <dd>
174 display text (string) 174 display text (string)
175 </dd> 175 </dd>
176 </dl> 176 </dl>
177 <a NAME="TemplateEntry.__expandFormattedVariable" ID="TemplateEntry.__expandFormattedVariable"></a> 177 <a NAME="TemplateEntry.__expandFormattedVariable" ID="TemplateEntry.__expandFormattedVariable"></a>
195 <dd> 195 <dd>
196 template text (string) 196 template text (string)
197 </dd> 197 </dd>
198 </dl> 198 </dl>
199 <dl> 199 <dl>
200 <dt>Returns:</dt> 200 <dt>Return:</dt>
201 <dd> 201 <dd>
202 expanded and formatted variable (string) 202 expanded and formatted variable (string)
203 </dd> 203 </dd>
204 </dl> 204 </dl>
205 <a NAME="TemplateEntry.__extractVariables" ID="TemplateEntry.__extractVariables"></a> 205 <a NAME="TemplateEntry.__extractVariables" ID="TemplateEntry.__extractVariables"></a>
215 215
216 <p> 216 <p>
217 Public method to get the description of the entry. 217 Public method to get the description of the entry.
218 </p> 218 </p>
219 <dl> 219 <dl>
220 <dt>Returns:</dt> 220 <dt>Return:</dt>
221 <dd> 221 <dd>
222 description of the entry (string) 222 description of the entry (string)
223 </dd> 223 </dd>
224 </dl> 224 </dl>
225 <a NAME="TemplateEntry.getExpandedText" ID="TemplateEntry.getExpandedText"></a> 225 <a NAME="TemplateEntry.getExpandedText" ID="TemplateEntry.getExpandedText"></a>
241 indentation of the line receiving he expanded 241 indentation of the line receiving he expanded
242 template text (string) 242 template text (string)
243 </dd> 243 </dd>
244 </dl> 244 </dl>
245 <dl> 245 <dl>
246 <dt>Returns:</dt> 246 <dt>Return:</dt>
247 <dd> 247 <dd>
248 a tuple of the expanded template text (string), the 248 a tuple of the expanded template text (string), the
249 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)
250 </dd> 250 </dd>
251 </dl> 251 </dl>
255 255
256 <p> 256 <p>
257 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.
258 </p> 258 </p>
259 <dl> 259 <dl>
260 <dt>Returns:</dt> 260 <dt>Return:</dt>
261 <dd> 261 <dd>
262 name of the group containing this entry (string) 262 name of the group containing this entry (string)
263 </dd> 263 </dd>
264 </dl> 264 </dl>
265 <a NAME="TemplateEntry.getName" ID="TemplateEntry.getName"></a> 265 <a NAME="TemplateEntry.getName" ID="TemplateEntry.getName"></a>
268 268
269 <p> 269 <p>
270 Public method to get the name of the entry. 270 Public method to get the name of the entry.
271 </p> 271 </p>
272 <dl> 272 <dl>
273 <dt>Returns:</dt> 273 <dt>Return:</dt>
274 <dd> 274 <dd>
275 name of the entry (string) 275 name of the entry (string)
276 </dd> 276 </dd>
277 </dl> 277 </dl>
278 <a NAME="TemplateEntry.getTemplateText" ID="TemplateEntry.getTemplateText"></a> 278 <a NAME="TemplateEntry.getTemplateText" ID="TemplateEntry.getTemplateText"></a>
281 281
282 <p> 282 <p>
283 Public method to get the template text. 283 Public method to get the template text.
284 </p> 284 </p>
285 <dl> 285 <dl>
286 <dt>Returns:</dt> 286 <dt>Return:</dt>
287 <dd> 287 <dd>
288 the template text (string) 288 the template text (string)
289 </dd> 289 </dd>
290 </dl> 290 </dl>
291 <a NAME="TemplateEntry.getVariables" ID="TemplateEntry.getVariables"></a> 291 <a NAME="TemplateEntry.getVariables" ID="TemplateEntry.getVariables"></a>
294 294
295 <p> 295 <p>
296 Public method to get the list of variables. 296 Public method to get the list of variables.
297 </p> 297 </p>
298 <dl> 298 <dl>
299 <dt>Returns:</dt> 299 <dt>Return:</dt>
300 <dd> 300 <dd>
301 list of variables (list of strings) 301 list of variables (list of strings)
302 </dd> 302 </dd>
303 </dl> 303 </dl>
304 <a NAME="TemplateEntry.setDescription" ID="TemplateEntry.setDescription"></a> 304 <a NAME="TemplateEntry.setDescription" ID="TemplateEntry.setDescription"></a>
477 477
478 <p> 478 <p>
479 Public method to retrieve all entries. 479 Public method to retrieve all entries.
480 </p> 480 </p>
481 <dl> 481 <dl>
482 <dt>Returns:</dt> 482 <dt>Return:</dt>
483 <dd> 483 <dd>
484 list of all entries (list of TemplateEntry) 484 list of all entries (list of TemplateEntry)
485 </dd> 485 </dd>
486 </dl> 486 </dl>
487 <a NAME="TemplateGroup.getEntry" ID="TemplateGroup.getEntry"></a> 487 <a NAME="TemplateGroup.getEntry" ID="TemplateGroup.getEntry"></a>
497 <dd> 497 <dd>
498 name of the entry to retrieve (string) 498 name of the entry to retrieve (string)
499 </dd> 499 </dd>
500 </dl> 500 </dl>
501 <dl> 501 <dl>
502 <dt>Returns:</dt> 502 <dt>Return:</dt>
503 <dd> 503 <dd>
504 reference to the entry (TemplateEntry) 504 reference to the entry (TemplateEntry)
505 </dd> 505 </dd>
506 </dl> 506 </dl>
507 <a NAME="TemplateGroup.getEntryNames" ID="TemplateGroup.getEntryNames"></a> 507 <a NAME="TemplateGroup.getEntryNames" ID="TemplateGroup.getEntryNames"></a>
519 string denoting the beginning of the template name 519 string denoting the beginning of the template name
520 (string) 520 (string)
521 </dd> 521 </dd>
522 </dl> 522 </dl>
523 <dl> 523 <dl>
524 <dt>Returns:</dt> 524 <dt>Return:</dt>
525 <dd> 525 <dd>
526 list of entry names found (list of strings) 526 list of entry names found (list of strings)
527 </dd> 527 </dd>
528 </dl> 528 </dl>
529 <a NAME="TemplateGroup.getLanguage" ID="TemplateGroup.getLanguage"></a> 529 <a NAME="TemplateGroup.getLanguage" ID="TemplateGroup.getLanguage"></a>
532 532
533 <p> 533 <p>
534 Public method to get the name of the group. 534 Public method to get the name of the group.
535 </p> 535 </p>
536 <dl> 536 <dl>
537 <dt>Returns:</dt> 537 <dt>Return:</dt>
538 <dd> 538 <dd>
539 language of the group (string) 539 language of the group (string)
540 </dd> 540 </dd>
541 </dl> 541 </dl>
542 <a NAME="TemplateGroup.getName" ID="TemplateGroup.getName"></a> 542 <a NAME="TemplateGroup.getName" ID="TemplateGroup.getName"></a>
545 545
546 <p> 546 <p>
547 Public method to get the name of the group. 547 Public method to get the name of the group.
548 </p> 548 </p>
549 <dl> 549 <dl>
550 <dt>Returns:</dt> 550 <dt>Return:</dt>
551 <dd> 551 <dd>
552 name of the group (string) 552 name of the group (string)
553 </dd> 553 </dd>
554 </dl> 554 </dl>
555 <a NAME="TemplateGroup.hasEntry" ID="TemplateGroup.hasEntry"></a> 555 <a NAME="TemplateGroup.hasEntry" ID="TemplateGroup.hasEntry"></a>
565 <dd> 565 <dd>
566 name of the entry to check for (string) 566 name of the entry to check for (string)
567 </dd> 567 </dd>
568 </dl> 568 </dl>
569 <dl> 569 <dl>
570 <dt>Returns:</dt> 570 <dt>Return:</dt>
571 <dd> 571 <dd>
572 flag indicating existence (boolean) 572 flag indicating existence (boolean)
573 </dd> 573 </dd>
574 </dl> 574 </dl>
575 <a NAME="TemplateGroup.removeAllEntries" ID="TemplateGroup.removeAllEntries"></a> 575 <a NAME="TemplateGroup.removeAllEntries" ID="TemplateGroup.removeAllEntries"></a>
832 832
833 <p> 833 <p>
834 Private method to return predefined variables. 834 Private method to return predefined variables.
835 </p> 835 </p>
836 <dl> 836 <dl>
837 <dt>Returns:</dt> 837 <dt>Return:</dt>
838 <dd> 838 <dd>
839 dictionary of predefined variables and their values 839 dictionary of predefined variables and their values
840 </dd> 840 </dd>
841 </dl> 841 </dl>
842 <a NAME="TemplateViewer.__import" ID="TemplateViewer.__import"></a> 842 <a NAME="TemplateViewer.__import" ID="TemplateViewer.__import"></a>
1047 1047
1048 <p> 1048 <p>
1049 Public method to get all groups. 1049 Public method to get all groups.
1050 </p> 1050 </p>
1051 <dl> 1051 <dl>
1052 <dt>Returns:</dt> 1052 <dt>Return:</dt>
1053 <dd> 1053 <dd>
1054 list of all groups (list of TemplateGroup) 1054 list of all groups (list of TemplateGroup)
1055 </dd> 1055 </dd>
1056 </dl> 1056 </dl>
1057 <a NAME="TemplateViewer.getGroupNames" ID="TemplateViewer.getGroupNames"></a> 1057 <a NAME="TemplateViewer.getGroupNames" ID="TemplateViewer.getGroupNames"></a>
1060 1060
1061 <p> 1061 <p>
1062 Public method to get all group names. 1062 Public method to get all group names.
1063 </p> 1063 </p>
1064 <dl> 1064 <dl>
1065 <dt>Returns:</dt> 1065 <dt>Return:</dt>
1066 <dd> 1066 <dd>
1067 list of all group names (list of strings) 1067 list of all group names (list of strings)
1068 </dd> 1068 </dd>
1069 </dl> 1069 </dl>
1070 <a NAME="TemplateViewer.getTemplateNames" ID="TemplateViewer.getTemplateNames"></a> 1070 <a NAME="TemplateViewer.getTemplateNames" ID="TemplateViewer.getTemplateNames"></a>
1086 name of the group to get the entry from (string). 1086 name of the group to get the entry from (string).
1087 None or empty means to look in all groups. 1087 None or empty means to look in all groups.
1088 </dd> 1088 </dd>
1089 </dl> 1089 </dl>
1090 <dl> 1090 <dl>
1091 <dt>Returns:</dt> 1091 <dt>Return:</dt>
1092 <dd> 1092 <dd>
1093 sorted list of matching template names (list of strings) 1093 sorted list of matching template names (list of strings)
1094 </dd> 1094 </dd>
1095 </dl> 1095 </dl>
1096 <a NAME="TemplateViewer.hasGroup" ID="TemplateViewer.hasGroup"></a> 1096 <a NAME="TemplateViewer.hasGroup" ID="TemplateViewer.hasGroup"></a>
1106 <dd> 1106 <dd>
1107 name of the group to be checked for (string) 1107 name of the group to be checked for (string)
1108 </dd> 1108 </dd>
1109 </dl> 1109 </dl>
1110 <dl> 1110 <dl>
1111 <dt>Returns:</dt> 1111 <dt>Return:</dt>
1112 <dd> 1112 <dd>
1113 flag indicating an existing group (boolean) 1113 flag indicating an existing group (boolean)
1114 </dd> 1114 </dd>
1115 </dl> 1115 </dl>
1116 <a NAME="TemplateViewer.hasTemplate" ID="TemplateViewer.hasTemplate"></a> 1116 <a NAME="TemplateViewer.hasTemplate" ID="TemplateViewer.hasTemplate"></a>
1131 name of the group to check for the entry (string). 1131 name of the group to check for the entry (string).
1132 None or empty means to check all groups. 1132 None or empty means to check all groups.
1133 </dd> 1133 </dd>
1134 </dl> 1134 </dl>
1135 <dl> 1135 <dl>
1136 <dt>Returns:</dt> 1136 <dt>Return:</dt>
1137 <dd> 1137 <dd>
1138 flag indicating the existence (boolean) 1138 flag indicating the existence (boolean)
1139 </dd> 1139 </dd>
1140 </dl> 1140 </dl>
1141 <a NAME="TemplateViewer.readTemplates" ID="TemplateViewer.readTemplates"></a> 1141 <a NAME="TemplateViewer.readTemplates" ID="TemplateViewer.readTemplates"></a>
1200 <dd> 1200 <dd>
1201 name of a templates file to read (string) 1201 name of a templates file to read (string)
1202 </dd> 1202 </dd>
1203 </dl> 1203 </dl>
1204 <dl> 1204 <dl>
1205 <dt>Returns:</dt> 1205 <dt>Return:</dt>
1206 <dd> 1206 <dd>
1207 flag indicating success (boolean) 1207 flag indicating success (boolean)
1208 </dd> 1208 </dd>
1209 </dl> 1209 </dl>
1210 <div align="right"><a href="#top">Up</a></div> 1210 <div align="right"><a href="#top">Up</a></div>

Mercurial Repository: eric

eric ide

mercurial