--- a/src/eric7/Documentation/Source/eric7.Templates.TemplateViewer.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Templates.TemplateViewer.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Templates.TemplateViewer</h1>
-
<p>
Module implementing a template viewer and associated classes.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#TemplateEntry">TemplateEntry</a></td>
<td>Class immplementing a template entry.</td>
@@ -33,35 +31,34 @@
<td>Class implementing the template viewer.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="TemplateEntry" ID="TemplateEntry"></a>
<h2>TemplateEntry</h2>
-
<p>
Class immplementing a template entry.
</p>
+
<h3>Derived from</h3>
QTreeWidgetItem
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#TemplateEntry.__init__">TemplateEntry</a></td>
<td>Constructor</td>
@@ -115,19 +112,20 @@
<td>Public method to update the template text.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="TemplateEntry.__init__" ID="TemplateEntry.__init__"></a>
<h4>TemplateEntry (Constructor)</h4>
<b>TemplateEntry</b>(<i>parent, name, description, templateText</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -150,10 +148,10 @@
<a NAME="TemplateEntry.__displayText" ID="TemplateEntry.__displayText"></a>
<h4>TemplateEntry.__displayText</h4>
<b>__displayText</b>(<i></i>)
-
<p>
Private method to generate the display text.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -169,10 +167,10 @@
<a NAME="TemplateEntry.__expandFormattedVariable" ID="TemplateEntry.__expandFormattedVariable"></a>
<h4>TemplateEntry.__expandFormattedVariable</h4>
<b>__expandFormattedVariable</b>(<i>var, val, txt</i>)
-
<p>
Private method to expand a template variable with special formatting.
</p>
+
<dl>
<dt><i>var</i> (str)</dt>
@@ -203,17 +201,17 @@
<a NAME="TemplateEntry.__extractVariables" ID="TemplateEntry.__extractVariables"></a>
<h4>TemplateEntry.__extractVariables</h4>
<b>__extractVariables</b>(<i></i>)
-
<p>
Private method to retrieve the list of variables.
</p>
+
<a NAME="TemplateEntry.getDescription" ID="TemplateEntry.getDescription"></a>
<h4>TemplateEntry.getDescription</h4>
<b>getDescription</b>(<i></i>)
-
<p>
Public method to get the description of the entry.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -229,10 +227,10 @@
<a NAME="TemplateEntry.getExpandedText" ID="TemplateEntry.getExpandedText"></a>
<h4>TemplateEntry.getExpandedText</h4>
<b>getExpandedText</b>(<i>varDict, indent</i>)
-
<p>
Public method to get the template text with all variables expanded.
</p>
+
<dl>
<dt><i>varDict</i> (dict)</dt>
@@ -262,10 +260,10 @@
<a NAME="TemplateEntry.getGroupName" ID="TemplateEntry.getGroupName"></a>
<h4>TemplateEntry.getGroupName</h4>
<b>getGroupName</b>(<i></i>)
-
<p>
Public method to get the name of the group this entry belongs to.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -281,10 +279,10 @@
<a NAME="TemplateEntry.getName" ID="TemplateEntry.getName"></a>
<h4>TemplateEntry.getName</h4>
<b>getName</b>(<i></i>)
-
<p>
Public method to get the name of the entry.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -300,10 +298,10 @@
<a NAME="TemplateEntry.getTemplateText" ID="TemplateEntry.getTemplateText"></a>
<h4>TemplateEntry.getTemplateText</h4>
<b>getTemplateText</b>(<i></i>)
-
<p>
Public method to get the template text.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -319,10 +317,10 @@
<a NAME="TemplateEntry.getVariables" ID="TemplateEntry.getVariables"></a>
<h4>TemplateEntry.getVariables</h4>
<b>getVariables</b>(<i></i>)
-
<p>
Public method to get the list of variables.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -338,10 +336,10 @@
<a NAME="TemplateEntry.setDescription" ID="TemplateEntry.setDescription"></a>
<h4>TemplateEntry.setDescription</h4>
<b>setDescription</b>(<i>description</i>)
-
<p>
Public method to update the description of the entry.
</p>
+
<dl>
<dt><i>description</i> (str)</dt>
@@ -352,10 +350,10 @@
<a NAME="TemplateEntry.setName" ID="TemplateEntry.setName"></a>
<h4>TemplateEntry.setName</h4>
<b>setName</b>(<i>name</i>)
-
<p>
Public method to update the name of the entry.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -366,10 +364,10 @@
<a NAME="TemplateEntry.setTemplateText" ID="TemplateEntry.setTemplateText"></a>
<h4>TemplateEntry.setTemplateText</h4>
<b>setTemplateText</b>(<i>templateText</i>)
-
<p>
Public method to update the template text.
</p>
+
<dl>
<dt><i>templateText</i> (str)</dt>
@@ -382,26 +380,24 @@
<hr />
<a NAME="TemplateGroup" ID="TemplateGroup"></a>
<h2>TemplateGroup</h2>
-
<p>
Class implementing a template group.
</p>
+
<h3>Derived from</h3>
QTreeWidgetItem
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#TemplateGroup.__init__">TemplateGroup</a></td>
<td>Constructor</td>
@@ -451,19 +447,20 @@
<td>Public method to update the name of the group.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="TemplateGroup.__init__" ID="TemplateGroup.__init__"></a>
<h4>TemplateGroup (Constructor)</h4>
<b>TemplateGroup</b>(<i>parent, name, language="All"</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -482,10 +479,10 @@
<a NAME="TemplateGroup.addEntry" ID="TemplateGroup.addEntry"></a>
<h4>TemplateGroup.addEntry</h4>
<b>addEntry</b>(<i>name, description, template, quiet=False</i>)
-
<p>
Public method to add a template entry to this group.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -508,10 +505,10 @@
<a NAME="TemplateGroup.getAllEntries" ID="TemplateGroup.getAllEntries"></a>
<h4>TemplateGroup.getAllEntries</h4>
<b>getAllEntries</b>(<i></i>)
-
<p>
Public method to retrieve all entries.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -527,10 +524,10 @@
<a NAME="TemplateGroup.getEntry" ID="TemplateGroup.getEntry"></a>
<h4>TemplateGroup.getEntry</h4>
<b>getEntry</b>(<i>name</i>)
-
<p>
Public method to get an entry.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -553,11 +550,11 @@
<a NAME="TemplateGroup.getEntryNames" ID="TemplateGroup.getEntryNames"></a>
<h4>TemplateGroup.getEntryNames</h4>
<b>getEntryNames</b>(<i>beginning</i>)
-
<p>
Public method to get the names of all entries, who's name starts with
the given string.
</p>
+
<dl>
<dt><i>beginning</i> (str)</dt>
@@ -580,10 +577,10 @@
<a NAME="TemplateGroup.getLanguage" ID="TemplateGroup.getLanguage"></a>
<h4>TemplateGroup.getLanguage</h4>
<b>getLanguage</b>(<i></i>)
-
<p>
Public method to get the name of the group.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -599,10 +596,10 @@
<a NAME="TemplateGroup.getName" ID="TemplateGroup.getName"></a>
<h4>TemplateGroup.getName</h4>
<b>getName</b>(<i></i>)
-
<p>
Public method to get the name of the group.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -618,10 +615,10 @@
<a NAME="TemplateGroup.hasEntry" ID="TemplateGroup.hasEntry"></a>
<h4>TemplateGroup.hasEntry</h4>
<b>hasEntry</b>(<i>name</i>)
-
<p>
Public method to check, if the group has an entry with the given name.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -644,17 +641,17 @@
<a NAME="TemplateGroup.removeAllEntries" ID="TemplateGroup.removeAllEntries"></a>
<h4>TemplateGroup.removeAllEntries</h4>
<b>removeAllEntries</b>(<i></i>)
-
<p>
Public method to remove all template entries of this group.
</p>
+
<a NAME="TemplateGroup.removeEntry" ID="TemplateGroup.removeEntry"></a>
<h4>TemplateGroup.removeEntry</h4>
<b>removeEntry</b>(<i>name</i>)
-
<p>
Public method to remove a template entry from this group.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -665,10 +662,10 @@
<a NAME="TemplateGroup.setLanguage" ID="TemplateGroup.setLanguage"></a>
<h4>TemplateGroup.setLanguage</h4>
<b>setLanguage</b>(<i>language</i>)
-
<p>
Public method to update the name of the group.
</p>
+
<dl>
<dt><i>language</i> (str)</dt>
@@ -679,10 +676,10 @@
<a NAME="TemplateGroup.setName" ID="TemplateGroup.setName"></a>
<h4>TemplateGroup.setName</h4>
<b>setName</b>(<i>name</i>)
-
<p>
Public method to update the name of the group.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -695,26 +692,24 @@
<hr />
<a NAME="TemplateViewer" ID="TemplateViewer"></a>
<h2>TemplateViewer</h2>
-
<p>
Class implementing the template viewer.
</p>
+
<h3>Derived from</h3>
QTreeWidget
<h3>Class Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#TemplateViewer.__init__">TemplateViewer</a></td>
<td>Constructor</td>
@@ -836,19 +831,20 @@
<td>Public method to write the templates data to a JSON file (.ecj).</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="TemplateViewer.__init__" ID="TemplateViewer.__init__"></a>
<h4>TemplateViewer (Constructor)</h4>
<b>TemplateViewer</b>(<i>parent, viewmanager</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QWidget)</dt>
@@ -863,45 +859,45 @@
<a NAME="TemplateViewer.__addEntry" ID="TemplateViewer.__addEntry"></a>
<h4>TemplateViewer.__addEntry</h4>
<b>__addEntry</b>(<i></i>)
-
<p>
Private slot to handle the Add Entry context menu action.
</p>
+
<a NAME="TemplateViewer.__addGroup" ID="TemplateViewer.__addGroup"></a>
<h4>TemplateViewer.__addGroup</h4>
<b>__addGroup</b>(<i></i>)
-
<p>
Private slot to handle the Add Group context menu action.
</p>
+
<a NAME="TemplateViewer.__configure" ID="TemplateViewer.__configure"></a>
<h4>TemplateViewer.__configure</h4>
<b>__configure</b>(<i></i>)
-
<p>
Private method to open the configuration dialog.
</p>
+
<a NAME="TemplateViewer.__edit" ID="TemplateViewer.__edit"></a>
<h4>TemplateViewer.__edit</h4>
<b>__edit</b>(<i></i>)
-
<p>
Private slot to handle the Edit context menu action.
</p>
+
<a NAME="TemplateViewer.__export" ID="TemplateViewer.__export"></a>
<h4>TemplateViewer.__export</h4>
<b>__export</b>(<i></i>)
-
<p>
Private slot to handle the Export context menu action.
</p>
+
<a NAME="TemplateViewer.__getPredefinedVars" ID="TemplateViewer.__getPredefinedVars"></a>
<h4>TemplateViewer.__getPredefinedVars</h4>
<b>__getPredefinedVars</b>(<i></i>)
-
<p>
Private method to return predefined variables.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -917,38 +913,38 @@
<a NAME="TemplateViewer.__import" ID="TemplateViewer.__import"></a>
<h4>TemplateViewer.__import</h4>
<b>__import</b>(<i></i>)
-
<p>
Private slot to handle the Import context menu action.
</p>
+
<a NAME="TemplateViewer.__reload" ID="TemplateViewer.__reload"></a>
<h4>TemplateViewer.__reload</h4>
<b>__reload</b>(<i></i>)
-
<p>
Private slot to reload the templates.
</p>
+
<a NAME="TemplateViewer.__remove" ID="TemplateViewer.__remove"></a>
<h4>TemplateViewer.__remove</h4>
<b>__remove</b>(<i></i>)
-
<p>
Private slot to handle the Remove context menu action.
</p>
+
<a NAME="TemplateViewer.__resort" ID="TemplateViewer.__resort"></a>
<h4>TemplateViewer.__resort</h4>
<b>__resort</b>(<i></i>)
-
<p>
Private method to resort the tree.
</p>
+
<a NAME="TemplateViewer.__showContextMenu" ID="TemplateViewer.__showContextMenu"></a>
<h4>TemplateViewer.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>coord</i>)
-
<p>
Private slot to show the context menu of the list.
</p>
+
<dl>
<dt><i>coord</i> (QPoint)</dt>
@@ -959,17 +955,17 @@
<a NAME="TemplateViewer.__showHelp" ID="TemplateViewer.__showHelp"></a>
<h4>TemplateViewer.__showHelp</h4>
<b>__showHelp</b>(<i></i>)
-
<p>
Private method to show some help.
</p>
+
<a NAME="TemplateViewer.__templateItemActivated" ID="TemplateViewer.__templateItemActivated"></a>
<h4>TemplateViewer.__templateItemActivated</h4>
<b>__templateItemActivated</b>(<i>itm=None, col=0</i>)
-
<p>
Private slot to handle the activation of an item.
</p>
+
<dl>
<dt><i>itm</i> (QTreeWidgetItem)</dt>
@@ -984,10 +980,10 @@
<a NAME="TemplateViewer.addEntry" ID="TemplateViewer.addEntry"></a>
<h4>TemplateViewer.addEntry</h4>
<b>addEntry</b>(<i>groupName, name, description, template, quiet=False</i>)
-
<p>
Public method to add a template entry.
</p>
+
<dl>
<dt><i>groupName</i> (str)</dt>
@@ -1014,10 +1010,10 @@
<a NAME="TemplateViewer.addGroup" ID="TemplateViewer.addGroup"></a>
<h4>TemplateViewer.addGroup</h4>
<b>addGroup</b>(<i>name, language="All"</i>)
-
<p>
Public method to add a group.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1032,10 +1028,10 @@
<a NAME="TemplateViewer.applyNamedTemplate" ID="TemplateViewer.applyNamedTemplate"></a>
<h4>TemplateViewer.applyNamedTemplate</h4>
<b>applyNamedTemplate</b>(<i>templateName, groupName=None</i>)
-
<p>
Public method to apply a template given a template name.
</p>
+
<dl>
<dt><i>templateName</i> (str)</dt>
@@ -1051,10 +1047,10 @@
<a NAME="TemplateViewer.applyTemplate" ID="TemplateViewer.applyTemplate"></a>
<h4>TemplateViewer.applyTemplate</h4>
<b>applyTemplate</b>(<i>itm</i>)
-
<p>
Public method to apply the template.
</p>
+
<dl>
<dt><i>itm</i> (TemplateEntry)</dt>
@@ -1065,10 +1061,10 @@
<a NAME="TemplateViewer.changeEntry" ID="TemplateViewer.changeEntry"></a>
<h4>TemplateViewer.changeEntry</h4>
<b>changeEntry</b>(<i>itm, name, groupName, description, template</i>)
-
<p>
Public method to change a template entry.
</p>
+
<dl>
<dt><i>itm</i> (TemplateEntry)</dt>
@@ -1095,10 +1091,10 @@
<a NAME="TemplateViewer.changeGroup" ID="TemplateViewer.changeGroup"></a>
<h4>TemplateViewer.changeGroup</h4>
<b>changeGroup</b>(<i>oldname, newname, language="All"</i>)
-
<p>
Public method to rename a group.
</p>
+
<dl>
<dt><i>oldname</i> (str)</dt>
@@ -1117,10 +1113,10 @@
<a NAME="TemplateViewer.getAllGroups" ID="TemplateViewer.getAllGroups"></a>
<h4>TemplateViewer.getAllGroups</h4>
<b>getAllGroups</b>(<i></i>)
-
<p>
Public method to get all groups.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1136,10 +1132,10 @@
<a NAME="TemplateViewer.getGroupNames" ID="TemplateViewer.getGroupNames"></a>
<h4>TemplateViewer.getGroupNames</h4>
<b>getGroupNames</b>(<i></i>)
-
<p>
Public method to get all group names.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1155,11 +1151,11 @@
<a NAME="TemplateViewer.getTemplateNames" ID="TemplateViewer.getTemplateNames"></a>
<h4>TemplateViewer.getTemplateNames</h4>
<b>getTemplateNames</b>(<i>start, groupName=None</i>)
-
<p>
Public method to get the names of templates starting with the
given string.
</p>
+
<dl>
<dt><i>start</i> (str)</dt>
@@ -1187,10 +1183,10 @@
<a NAME="TemplateViewer.hasGroup" ID="TemplateViewer.hasGroup"></a>
<h4>TemplateViewer.hasGroup</h4>
<b>hasGroup</b>(<i>name</i>)
-
<p>
Public method to check, if a group with the given name exists.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1213,10 +1209,10 @@
<a NAME="TemplateViewer.hasTemplate" ID="TemplateViewer.hasTemplate"></a>
<h4>TemplateViewer.hasTemplate</h4>
<b>hasTemplate</b>(<i>entryName, groupName=None</i>)
-
<p>
Public method to check, if an entry of the given name exists.
</p>
+
<dl>
<dt><i>entryName</i> (str)</dt>
@@ -1244,10 +1240,10 @@
<a NAME="TemplateViewer.readTemplates" ID="TemplateViewer.readTemplates"></a>
<h4>TemplateViewer.readTemplates</h4>
<b>readTemplates</b>(<i>filename=None</i>)
-
<p>
Public method to read in the templates file (.e4c).
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -1258,10 +1254,10 @@
<a NAME="TemplateViewer.removeEntry" ID="TemplateViewer.removeEntry"></a>
<h4>TemplateViewer.removeEntry</h4>
<b>removeEntry</b>(<i>itm</i>)
-
<p>
Public method to remove a template entry.
</p>
+
<dl>
<dt><i>itm</i> (TemplateEntry)</dt>
@@ -1272,10 +1268,10 @@
<a NAME="TemplateViewer.removeGroup" ID="TemplateViewer.removeGroup"></a>
<h4>TemplateViewer.removeGroup</h4>
<b>removeGroup</b>(<i>itm</i>)
-
<p>
Public method to remove a group.
</p>
+
<dl>
<dt><i>itm</i> (TemplateGroup)</dt>
@@ -1286,17 +1282,17 @@
<a NAME="TemplateViewer.save" ID="TemplateViewer.save"></a>
<h4>TemplateViewer.save</h4>
<b>save</b>(<i></i>)
-
<p>
Public slot to save the templates.
</p>
+
<a NAME="TemplateViewer.writeTemplates" ID="TemplateViewer.writeTemplates"></a>
<h4>TemplateViewer.writeTemplates</h4>
<b>writeTemplates</b>(<i>filename=None</i>)
-
<p>
Public method to write the templates data to a JSON file (.ecj).
</p>
+
<dl>
<dt><i>filename</i> (str)</dt>
@@ -1318,4 +1314,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
