Mercurial Repositories > eric / file diff

diff: src/eric7/Documentation/Source/eric7.Templates.TemplateViewer.html

src/eric7/Documentation/Source/eric7.Templates.TemplateViewer.html

branch
eric7
changeset 10431
64157aeb0312
parent 9209
b99e7fd55fd3
child 10479
856476537696
--- a/src/eric7/Documentation/Source/eric7.Templates.TemplateViewer.html	Wed Dec 20 19:28:22 2023 +0100
+++ b/src/eric7/Documentation/Source/eric7.Templates.TemplateViewer.html	Thu Dec 21 12:03:40 2023 +0100
@@ -130,21 +130,21 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget of the template entry (QWidget)
+parent widget of the template entry
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the entry (string)
+name of the entry
 </dd>
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-descriptive text for the template (string)
+descriptive text for the template
 </dd>
-<dt><i>templateText</i></dt>
+<dt><i>templateText</i> (str)</dt>
 <dd>
-text of the template entry (string)
+text of the template entry
 </dd>
 </dl>
 <a NAME="TemplateEntry.__displayText" ID="TemplateEntry.__displayText"></a>
@@ -157,7 +157,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-display text (string)
+display text
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="TemplateEntry.__expandFormattedVariable" ID="TemplateEntry.__expandFormattedVariable"></a>
@@ -169,23 +175,29 @@
 </p>
 <dl>
 
-<dt><i>var</i></dt>
+<dt><i>var</i> (str)</dt>
 <dd>
-template variable name (string)
+template variable name
 </dd>
-<dt><i>val</i></dt>
+<dt><i>val</i> (str)</dt>
 <dd>
-value of the template variable (string)
+value of the template variable
 </dd>
-<dt><i>txt</i></dt>
+<dt><i>txt</i> (str)</dt>
 <dd>
-template text (string)
+template text
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-expanded and formatted variable (string)
+expanded and formatted variable
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="TemplateEntry.__extractVariables" ID="TemplateEntry.__extractVariables"></a>
@@ -205,7 +217,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-description of the entry (string)
+description of the entry
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="TemplateEntry.getExpandedText" ID="TemplateEntry.getExpandedText"></a>
@@ -217,22 +235,28 @@
 </p>
 <dl>
 
-<dt><i>varDict</i></dt>
+<dt><i>varDict</i> (dict)</dt>
 <dd>
 dictionary containing the texts of each variable
-            with the variable name as key.
+            with the variable name as key
 </dd>
-<dt><i>indent</i></dt>
+<dt><i>indent</i> (str)</dt>
 <dd>
 indentation of the line receiving he expanded
-            template text (string)
+            template text
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-a tuple of the expanded template text (string), the
-            number of lines (integer) and the length of the last line (integer)
+a tuple of the expanded template text, the number of lines
+            and the length of the last line
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, int, int)
 </dd>
 </dl>
 <a NAME="TemplateEntry.getGroupName" ID="TemplateEntry.getGroupName"></a>
@@ -245,7 +269,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the group containing this entry (string)
+name of the group containing this entry
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="TemplateEntry.getName" ID="TemplateEntry.getName"></a>
@@ -258,7 +288,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the entry (string)
+name of the entry
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="TemplateEntry.getTemplateText" ID="TemplateEntry.getTemplateText"></a>
@@ -271,7 +307,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-the template text (string)
+the template text
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="TemplateEntry.getVariables" ID="TemplateEntry.getVariables"></a>
@@ -284,7 +326,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of variables (list of strings)
+list of variables
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="TemplateEntry.setDescription" ID="TemplateEntry.setDescription"></a>
@@ -296,9 +344,9 @@
 </p>
 <dl>
 
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-description of the entry (string)
+description of the entry
 </dd>
 </dl>
 <a NAME="TemplateEntry.setName" ID="TemplateEntry.setName"></a>
@@ -310,9 +358,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the entry (string)
+name of the entry
 </dd>
 </dl>
 <a NAME="TemplateEntry.setTemplateText" ID="TemplateEntry.setTemplateText"></a>
@@ -324,9 +372,9 @@
 </p>
 <dl>
 
-<dt><i>templateText</i></dt>
+<dt><i>templateText</i> (str)</dt>
 <dd>
-text of the template entry (string)
+text of the template entry
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -418,17 +466,17 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-parent widget of the template group (QWidget)
+parent widget of the template group
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the group (string)
+name of the group
 </dd>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-programming language for the group (string)
+programming language for the group
 </dd>
 </dl>
 <a NAME="TemplateGroup.addEntry" ID="TemplateGroup.addEntry"></a>
@@ -440,21 +488,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the entry (string)
+name of the entry
 </dd>
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-description of the entry to add (string)
+description of the entry to add
 </dd>
-<dt><i>template</i></dt>
+<dt><i>template</i> (str)</dt>
 <dd>
-template text of the entry (string)
+template text of the entry
 </dd>
-<dt><i>quiet</i></dt>
+<dt><i>quiet</i> (bool)</dt>
 <dd>
-flag indicating quiet operation (boolean)
+flag indicating quiet operation
 </dd>
 </dl>
 <a NAME="TemplateGroup.getAllEntries" ID="TemplateGroup.getAllEntries"></a>
@@ -467,7 +515,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of all entries (list of TemplateEntry)
+list of all entries
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of TemplateEntry
 </dd>
 </dl>
 <a NAME="TemplateGroup.getEntry" ID="TemplateGroup.getEntry"></a>
@@ -479,15 +533,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the entry to retrieve (string)
+name of the entry to retrieve
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-reference to the entry (TemplateEntry)
+reference to the entry
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+TemplateEntry
 </dd>
 </dl>
 <a NAME="TemplateGroup.getEntryNames" ID="TemplateGroup.getEntryNames"></a>
@@ -500,16 +560,21 @@
 </p>
 <dl>
 
-<dt><i>beginning</i></dt>
+<dt><i>beginning</i> (str)</dt>
 <dd>
 string denoting the beginning of the template name
-            (string)
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-list of entry names found (list of strings)
+list of entry names found
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="TemplateGroup.getLanguage" ID="TemplateGroup.getLanguage"></a>
@@ -522,7 +587,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-language of the group (string)
+language of the group
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="TemplateGroup.getName" ID="TemplateGroup.getName"></a>
@@ -535,7 +606,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-name of the group (string)
+name of the group
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+str
 </dd>
 </dl>
 <a NAME="TemplateGroup.hasEntry" ID="TemplateGroup.hasEntry"></a>
@@ -547,15 +624,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the entry to check for (string)
+name of the entry to check for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating existence (boolean)
+flag indicating existence
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="TemplateGroup.removeAllEntries" ID="TemplateGroup.removeAllEntries"></a>
@@ -574,9 +657,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the entry to be removed (string)
+name of the entry to be removed
 </dd>
 </dl>
 <a NAME="TemplateGroup.setLanguage" ID="TemplateGroup.setLanguage"></a>
@@ -588,9 +671,9 @@
 </p>
 <dl>
 
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-programming language for the group (string)
+programming language for the group
 </dd>
 </dl>
 <a NAME="TemplateGroup.setName" ID="TemplateGroup.setName"></a>
@@ -602,9 +685,9 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the group (string)
+name of the group
 </dd>
 </dl>
 <div align="right"><a href="#top">Up</a></div>
@@ -768,11 +851,11 @@
 </p>
 <dl>
 
-<dt><i>parent</i></dt>
+<dt><i>parent</i> (QWidget)</dt>
 <dd>
-the parent (QWidget)
+the parent
 </dd>
-<dt><i>viewmanager</i></dt>
+<dt><i>viewmanager</i> (ViewManager)</dt>
 <dd>
 reference to the viewmanager object
 </dd>
@@ -825,6 +908,12 @@
 dictionary of predefined variables and their values
 </dd>
 </dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+dict
+</dd>
+</dl>
 <a NAME="TemplateViewer.__import" ID="TemplateViewer.__import"></a>
 <h4>TemplateViewer.__import</h4>
 <b>__import</b>(<i></i>)
@@ -862,9 +951,9 @@
 </p>
 <dl>
 
-<dt><i>coord</i></dt>
+<dt><i>coord</i> (QPoint)</dt>
 <dd>
-the position of the mouse pointer (QPoint)
+the position of the mouse pointer
 </dd>
 </dl>
 <a NAME="TemplateViewer.__showHelp" ID="TemplateViewer.__showHelp"></a>
@@ -883,13 +972,13 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the activated item (QTreeWidgetItem)
+reference to the activated item
 </dd>
-<dt><i>col</i></dt>
+<dt><i>col</i> (int)</dt>
 <dd>
-column the item was activated in (integer)
+column the item was activated in
 </dd>
 </dl>
 <a NAME="TemplateViewer.addEntry" ID="TemplateViewer.addEntry"></a>
@@ -901,25 +990,25 @@
 </p>
 <dl>
 
-<dt><i>groupName</i></dt>
+<dt><i>groupName</i> (str)</dt>
 <dd>
-name of the group to add to (string)
+name of the group to add to
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the entry to add (string)
+name of the entry to add
 </dd>
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-description of the entry to add (string)
+description of the entry to add
 </dd>
-<dt><i>template</i></dt>
+<dt><i>template</i> (str)</dt>
 <dd>
-template text of the entry (string)
+template text of the entry
 </dd>
-<dt><i>quiet</i></dt>
+<dt><i>quiet</i> (bool)</dt>
 <dd>
-flag indicating quiet operation (boolean)
+flag indicating quiet operation
 </dd>
 </dl>
 <a NAME="TemplateViewer.addGroup" ID="TemplateViewer.addGroup"></a>
@@ -931,13 +1020,13 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the group to be added (string)
+name of the group to be added
 </dd>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-programming language for the group (string)
+programming language for the group
 </dd>
 </dl>
 <a NAME="TemplateViewer.applyNamedTemplate" ID="TemplateViewer.applyNamedTemplate"></a>
@@ -949,15 +1038,14 @@
 </p>
 <dl>
 
-<dt><i>templateName</i></dt>
+<dt><i>templateName</i> (str)</dt>
 <dd>
-name of the template item to apply (string)
+name of the template item to apply
 </dd>
-<dt><i>groupName</i></dt>
+<dt><i>groupName</i> (str)</dt>
 <dd>
-name of the group to get the entry from (string).
-            None or empty means to apply the first template found with the
-            given name.
+name of the group to get the entry from. None or empty means
+            to apply the first template found with the given name.
 </dd>
 </dl>
 <a NAME="TemplateViewer.applyTemplate" ID="TemplateViewer.applyTemplate"></a>
@@ -969,9 +1057,9 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (TemplateEntry)</dt>
 <dd>
-reference to the template item to apply (TemplateEntry)
+reference to the template item to apply
 </dd>
 </dl>
 <a NAME="TemplateViewer.changeEntry" ID="TemplateViewer.changeEntry"></a>
@@ -983,26 +1071,25 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (TemplateEntry)</dt>
 <dd>
-template entry to be changed (TemplateEntry)
+template entry to be changed
 </dd>
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-new name for the entry (string)
+new name for the entry
 </dd>
-<dt><i>groupName</i></dt>
+<dt><i>groupName</i> (str)</dt>
 <dd>
 name of the group the entry should belong to
-            (string)
 </dd>
-<dt><i>description</i></dt>
+<dt><i>description</i> (str)</dt>
 <dd>
-description of the entry (string)
+description of the entry
 </dd>
-<dt><i>template</i></dt>
+<dt><i>template</i> (str)</dt>
 <dd>
-template text of the entry (string)
+template text of the entry
 </dd>
 </dl>
 <a NAME="TemplateViewer.changeGroup" ID="TemplateViewer.changeGroup"></a>
@@ -1014,17 +1101,17 @@
 </p>
 <dl>
 
-<dt><i>oldname</i></dt>
+<dt><i>oldname</i> (str)</dt>
 <dd>
-old name of the group (string)
+old name of the group
 </dd>
-<dt><i>newname</i></dt>
+<dt><i>newname</i> (str)</dt>
 <dd>
-new name of the group (string)
+new name of the group
 </dd>
-<dt><i>language</i></dt>
+<dt><i>language</i> (str)</dt>
 <dd>
-programming language for the group (string)
+programming language for the group
 </dd>
 </dl>
 <a NAME="TemplateViewer.getAllGroups" ID="TemplateViewer.getAllGroups"></a>
@@ -1037,7 +1124,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of all groups (list of TemplateGroup)
+list of all groups
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of TemplateGroup
 </dd>
 </dl>
 <a NAME="TemplateViewer.getGroupNames" ID="TemplateViewer.getGroupNames"></a>
@@ -1050,7 +1143,13 @@
 <dl>
 <dt>Return:</dt>
 <dd>
-list of all group names (list of strings)
+list of all group names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="TemplateViewer.getTemplateNames" ID="TemplateViewer.getTemplateNames"></a>
@@ -1063,20 +1162,26 @@
 </p>
 <dl>
 
-<dt><i>start</i></dt>
+<dt><i>start</i> (str)</dt>
 <dd>
-start string of the name (string)
+start string of the name
 </dd>
-<dt><i>groupName</i></dt>
+<dt><i>groupName</i> (str)</dt>
 <dd>
-name of the group to get the entry from (string).
-            None or empty means to look in all groups.
+name of the group to get the entry from. None or empty
+            means to look in all groups.
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-sorted list of matching template names (list of strings)
+sorted list of matching template names
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
 </dd>
 </dl>
 <a NAME="TemplateViewer.hasGroup" ID="TemplateViewer.hasGroup"></a>
@@ -1088,15 +1193,21 @@
 </p>
 <dl>
 
-<dt><i>name</i></dt>
+<dt><i>name</i> (str)</dt>
 <dd>
-name of the group to be checked for (string)
+name of the group to be checked for
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating an existing group (boolean)
+flag indicating an existing group
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="TemplateViewer.hasTemplate" ID="TemplateViewer.hasTemplate"></a>
@@ -1108,20 +1219,26 @@
 </p>
 <dl>
 
-<dt><i>entryName</i></dt>
+<dt><i>entryName</i> (str)</dt>
 <dd>
-name of the entry to check for (string)
+name of the entry to check for
 </dd>
-<dt><i>groupName</i></dt>
+<dt><i>groupName</i> (str)</dt>
 <dd>
-name of the group to check for the entry (string).
-            None or empty means to check all groups.
+name of the group to check for the entry. None or empty means
+            to check all groups.
 </dd>
 </dl>
 <dl>
 <dt>Return:</dt>
 <dd>
-flag indicating the existence (boolean)
+flag indicating the existence
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+bool
 </dd>
 </dl>
 <a NAME="TemplateViewer.readTemplates" ID="TemplateViewer.readTemplates"></a>
@@ -1147,9 +1264,9 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (TemplateEntry)</dt>
 <dd>
-template entry to be removed (TemplateEntry)
+template entry to be removed
 </dd>
 </dl>
 <a NAME="TemplateViewer.removeGroup" ID="TemplateViewer.removeGroup"></a>
@@ -1161,9 +1278,9 @@
 </p>
 <dl>
 
-<dt><i>itm</i></dt>
+<dt><i>itm</i> (TemplateGroup)</dt>
 <dd>
-template group to be removed (TemplateGroup)
+template group to be removed
 </dd>
 </dl>
 <a NAME="TemplateViewer.save" ID="TemplateViewer.save"></a>

Mercurial Repository: eric

eric ide

mercurial