src/eric7/Documentation/Source/eric7.UI.FindFileFilterPropertiesDialog.html

branch
eric7
changeset 10493
f795d68d8e09
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/eric7/Documentation/Source/eric7.UI.FindFileFilterPropertiesDialog.html	Wed Jan 10 09:44:42 2024 +0100
@@ -0,0 +1,125 @@
+<!DOCTYPE html>
+<html><head>
+<title>eric7.UI.FindFileFilterPropertiesDialog</title>
+<meta charset="UTF-8">
+<link rel="stylesheet" href="styles.css">
+</head>
+<body>
+<a NAME="top" ID="top"></a>
+<h1>eric7.UI.FindFileFilterPropertiesDialog</h1>
+<p>
+Module implementing a dialog to enter the file filter properties.
+</p>
+
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#FindFileFilterPropertiesDialog">FindFileFilterPropertiesDialog</a></td>
+<td>Class implementing a dialog to enter the file filter properties.</td>
+</tr>
+</table>
+
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<hr />
+<hr />
+<a NAME="FindFileFilterPropertiesDialog" ID="FindFileFilterPropertiesDialog"></a>
+<h2>FindFileFilterPropertiesDialog</h2>
+<p>
+    Class implementing a dialog to enter the file filter properties.
+</p>
+
+<h3>Derived from</h3>
+QDialog, Ui_FindFileFilterPropertiesDialog
+<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="#FindFileFilterPropertiesDialog.__init__">FindFileFilterPropertiesDialog</a></td>
+<td>Constructor</td>
+</tr>
+<tr>
+<td><a href="#FindFileFilterPropertiesDialog.__updateOKAndError">__updateOKAndError</a></td>
+<td>Private slot to set the enabled state of the OK button.</td>
+</tr>
+<tr>
+<td><a href="#FindFileFilterPropertiesDialog.getProperties">getProperties</a></td>
+<td>Public method to retrieve the entered filter properties.</td>
+</tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
+<a NAME="FindFileFilterPropertiesDialog.__init__" ID="FindFileFilterPropertiesDialog.__init__"></a>
+<h4>FindFileFilterPropertiesDialog (Constructor)</h4>
+<b>FindFileFilterPropertiesDialog</b>(<i>currentFilters, properties=None, parent=None</i>)
+<p>
+        Constructor
+</p>
+
+<dl>
+
+<dt><i>currentFilters</i> (list of str)</dt>
+<dd>
+list of existing filters to check against
+</dd>
+<dt><i>properties</i> (tuple of (str, str) (optional))</dt>
+<dd>
+tuple containing the filter name and pattern
+            to be edited (defaults to None)
+</dd>
+<dt><i>parent</i> (QWidget (optional))</dt>
+<dd>
+reference to the parent widget (defaults to None)
+</dd>
+</dl>
+<a NAME="FindFileFilterPropertiesDialog.__updateOKAndError" ID="FindFileFilterPropertiesDialog.__updateOKAndError"></a>
+<h4>FindFileFilterPropertiesDialog.__updateOKAndError</h4>
+<b>__updateOKAndError</b>(<i></i>)
+<p>
+        Private slot to set the enabled state of the OK button.
+</p>
+
+<a NAME="FindFileFilterPropertiesDialog.getProperties" ID="FindFileFilterPropertiesDialog.getProperties"></a>
+<h4>FindFileFilterPropertiesDialog.getProperties</h4>
+<b>getProperties</b>(<i></i>)
+<p>
+        Public method to retrieve the entered filter properties.
+</p>
+
+<dl>
+<dt>Return:</dt>
+<dd>
+tuple cotaining the filter name and pattern
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+tuple of (str, str)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>

eric ide

mercurial