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

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 10431
64157aeb0312
diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.Templates.TemplatePropertiesDialog.html
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.Templates.TemplatePropertiesDialog.html	Thu Jul 07 11:23:56 2022 +0200
@@ -0,0 +1,159 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.Templates.TemplatePropertiesDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.Templates.TemplatePropertiesDialog</h1>
+
+<p>
+Module implementing the templates properties dialog.
+</p>
+<h3>Global Attributes</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+
+<table>
+
+<tr>
+<td><a href="#TemplatePropertiesDialog">TemplatePropertiesDialog</a></td>
+<td>Class implementing the templates properties dialog.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr />
+<hr />
+<a NAME="TemplatePropertiesDialog" ID="TemplatePropertiesDialog"></a>
+<h2>TemplatePropertiesDialog</h2>
+
+<p>
+    Class implementing the templates properties dialog.
+</p>
+<h3>Derived from</h3>
+QDialog, Ui_TemplatePropertiesDialog
+<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="#TemplatePropertiesDialog.__init__">TemplatePropertiesDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#TemplatePropertiesDialog.getData">getData</a></td>
+<td>Public method to get the data entered into the dialog.</td>
+</tr>
+<tr>
+<td><a href="#TemplatePropertiesDialog.keyPressEvent">keyPressEvent</a></td>
+<td>Protected method to handle the user pressing the escape key.</td>
+</tr>
+<tr>
+<td><a href="#TemplatePropertiesDialog.on_helpButton_clicked">on_helpButton_clicked</a></td>
+<td>Private slot to show some help.</td>
+</tr>
+<tr>
+<td><a href="#TemplatePropertiesDialog.setSelectedGroup">setSelectedGroup</a></td>
+<td>Public method to select a group.</td>
+</tr>
+</table>
+<h3>Static Methods</h3>
+
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<a NAME="TemplatePropertiesDialog.__init__" ID="TemplatePropertiesDialog.__init__"></a>
+<h4>TemplatePropertiesDialog (Constructor)</h4>
+<b>TemplatePropertiesDialog</b>(<i>parent, groupMode=False, itm=None</i>)
+
+<p>
+        Constructor
+</p>
+<dl>
+
+<dt><i>parent</i></dt>
+<dd>
+the parent widget (QWidget)
+</dd>
+<dt><i>groupMode</i></dt>
+<dd>
+flag indicating group mode (boolean)
+</dd>
+<dt><i>itm</i></dt>
+<dd>
+item (TemplateEntry or TemplateGroup) to
+            read the data from
+</dd>
+</dl>
+<a NAME="TemplatePropertiesDialog.getData" ID="TemplatePropertiesDialog.getData"></a>
+<h4>TemplatePropertiesDialog.getData</h4>
+<b>getData</b>(<i></i>)
+
+<p>
+        Public method to get the data entered into the dialog.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+a tuple of two strings (name, language), if the dialog is in
+            group mode, and a tuple of four strings (name, description, group
+            name, template) otherwise.
+</dd>
+</dl>
+<a NAME="TemplatePropertiesDialog.keyPressEvent" ID="TemplatePropertiesDialog.keyPressEvent"></a>
+<h4>TemplatePropertiesDialog.keyPressEvent</h4>
+<b>keyPressEvent</b>(<i>ev</i>)
+
+<p>
+        Protected method to handle the user pressing the escape key.
+</p>
+<dl>
+
+<dt><i>ev</i></dt>
+<dd>
+key event (QKeyEvent)
+</dd>
+</dl>
+<a NAME="TemplatePropertiesDialog.on_helpButton_clicked" ID="TemplatePropertiesDialog.on_helpButton_clicked"></a>
+<h4>TemplatePropertiesDialog.on_helpButton_clicked</h4>
+<b>on_helpButton_clicked</b>(<i></i>)
+
+<p>
+        Private slot to show some help.
+</p>
+<a NAME="TemplatePropertiesDialog.setSelectedGroup" ID="TemplatePropertiesDialog.setSelectedGroup"></a>
+<h4>TemplatePropertiesDialog.setSelectedGroup</h4>
+<b>setSelectedGroup</b>(<i>name</i>)
+
+<p>
+        Public method to select a group.
+</p>
+<dl>
+
+<dt><i>name</i></dt>
+<dd>
+name of the group to be selected (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file

eric ide

mercurial