diff -r 53eac4c7d10b -r f795d68d8e09 src/eric7/Documentation/Source/eric7.UI.FindFileFiltersEditDialog.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.UI.FindFileFiltersEditDialog.html Wed Jan 10 09:44:42 2024 +0100 @@ -0,0 +1,225 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.UI.FindFileFiltersEditDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.UI.FindFileFiltersEditDialog</h1> +<p> +Module implementing a dialog to configure the file filters. +</p> + +<h3>Global Attributes</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Classes</h3> +<table> +<tr> +<td><a href="#FindFileFiltersEditDialog">FindFileFiltersEditDialog</a></td> +<td>Class implementing a dialog to configure the file filters.</td> +</tr> +</table> + +<h3>Functions</h3> +<table> +<tr><td>None</td></tr> +</table> + +<hr /> +<hr /> +<a NAME="FindFileFiltersEditDialog" ID="FindFileFiltersEditDialog"></a> +<h2>FindFileFiltersEditDialog</h2> +<p> + Class implementing a dialog to configure the file filters. +</p> + +<h3>Derived from</h3> +QDialog, Ui_FindFileFiltersEditDialog +<h3>Class Attributes</h3> +<table> +<tr><td>FilterPatternRole</td></tr> +<tr><td>FilterTextRole</td></tr> +</table> + +<h3>Class Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + +<h3>Methods</h3> +<table> +<tr> +<td><a href="#FindFileFiltersEditDialog.__init__">FindFileFiltersEditDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#FindFileFiltersEditDialog.__adjustColumns">__adjustColumns</a></td> +<td>Private method to adjust the column widths.</td> +</tr> +<tr> +<td><a href="#FindFileFiltersEditDialog.__getFiltersList">__getFiltersList</a></td> +<td>Private method to get the list of defined filter names.</td> +</tr> +<tr> +<td><a href="#FindFileFiltersEditDialog.__populateFilters">__populateFilters</a></td> +<td>Private method to populate the filters list.</td> +</tr> +<tr> +<td><a href="#FindFileFiltersEditDialog.getFilters">getFilters</a></td> +<td>Public method to retrieve the edited filter list.</td> +</tr> +<tr> +<td><a href="#FindFileFiltersEditDialog.on_addFileFilterButton_clicked">on_addFileFilterButton_clicked</a></td> +<td>Private slot to add a new filter entry.</td> +</tr> +<tr> +<td><a href="#FindFileFiltersEditDialog.on_defaultFiltersButton_clicked">on_defaultFiltersButton_clicked</a></td> +<td>Private slot to create the default list of file filters.</td> +</tr> +<tr> +<td><a href="#FindFileFiltersEditDialog.on_deleteFileFilterButton_clicked">on_deleteFileFilterButton_clicked</a></td> +<td>Private slot to delete the selected filter entries.</td> +</tr> +<tr> +<td><a href="#FindFileFiltersEditDialog.on_editFileFilterButton_clicked">on_editFileFilterButton_clicked</a></td> +<td>Private slot to edit the selected filter entry..</td> +</tr> +<tr> +<td><a href="#FindFileFiltersEditDialog.on_fileFiltersList_itemSelectionChanged">on_fileFiltersList_itemSelectionChanged</a></td> +<td>Private slot to handle a change of the selected items.</td> +</tr> +</table> + +<h3>Static Methods</h3> +<table> +<tr><td>None</td></tr> +</table> + + +<a NAME="FindFileFiltersEditDialog.__init__" ID="FindFileFiltersEditDialog.__init__"></a> +<h4>FindFileFiltersEditDialog (Constructor)</h4> +<b>FindFileFiltersEditDialog</b>(<i>filters, parent=None</i>) +<p> + Constructor +</p> + +<dl> + +<dt><i>filters</i> (dict)</dt> +<dd> +dictionary containing the existing file filters +</dd> +<dt><i>parent</i> (QWidget (optional))</dt> +<dd> +reference to the parent widget (defaults to None) +</dd> +</dl> +<a NAME="FindFileFiltersEditDialog.__adjustColumns" ID="FindFileFiltersEditDialog.__adjustColumns"></a> +<h4>FindFileFiltersEditDialog.__adjustColumns</h4> +<b>__adjustColumns</b>(<i></i>) +<p> + Private method to adjust the column widths. +</p> + +<a NAME="FindFileFiltersEditDialog.__getFiltersList" ID="FindFileFiltersEditDialog.__getFiltersList"></a> +<h4>FindFileFiltersEditDialog.__getFiltersList</h4> +<b>__getFiltersList</b>(<i>forEdit=False</i>) +<p> + Private method to get the list of defined filter names. +</p> + +<dl> + +<dt><i>forEdit</i> (bool (optional))</dt> +<dd> +flag indicating a list for an edit operation + (defaults to False) +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of defined filter names +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<a NAME="FindFileFiltersEditDialog.__populateFilters" ID="FindFileFiltersEditDialog.__populateFilters"></a> +<h4>FindFileFiltersEditDialog.__populateFilters</h4> +<b>__populateFilters</b>(<i>filters</i>) +<p> + Private method to populate the filters list. +</p> + +<dl> + +<dt><i>filters</i> (dict)</dt> +<dd> +dictionary containing the existing file filters +</dd> +</dl> +<a NAME="FindFileFiltersEditDialog.getFilters" ID="FindFileFiltersEditDialog.getFilters"></a> +<h4>FindFileFiltersEditDialog.getFilters</h4> +<b>getFilters</b>(<i></i>) +<p> + Public method to retrieve the edited filter list. +</p> + +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the defined file filters +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="FindFileFiltersEditDialog.on_addFileFilterButton_clicked" ID="FindFileFiltersEditDialog.on_addFileFilterButton_clicked"></a> +<h4>FindFileFiltersEditDialog.on_addFileFilterButton_clicked</h4> +<b>on_addFileFilterButton_clicked</b>(<i></i>) +<p> + Private slot to add a new filter entry. +</p> + +<a NAME="FindFileFiltersEditDialog.on_defaultFiltersButton_clicked" ID="FindFileFiltersEditDialog.on_defaultFiltersButton_clicked"></a> +<h4>FindFileFiltersEditDialog.on_defaultFiltersButton_clicked</h4> +<b>on_defaultFiltersButton_clicked</b>(<i></i>) +<p> + Private slot to create the default list of file filters. +</p> + +<a NAME="FindFileFiltersEditDialog.on_deleteFileFilterButton_clicked" ID="FindFileFiltersEditDialog.on_deleteFileFilterButton_clicked"></a> +<h4>FindFileFiltersEditDialog.on_deleteFileFilterButton_clicked</h4> +<b>on_deleteFileFilterButton_clicked</b>(<i></i>) +<p> + Private slot to delete the selected filter entries. +</p> + +<a NAME="FindFileFiltersEditDialog.on_editFileFilterButton_clicked" ID="FindFileFiltersEditDialog.on_editFileFilterButton_clicked"></a> +<h4>FindFileFiltersEditDialog.on_editFileFilterButton_clicked</h4> +<b>on_editFileFilterButton_clicked</b>(<i></i>) +<p> + Private slot to edit the selected filter entry.. +</p> + +<a NAME="FindFileFiltersEditDialog.on_fileFiltersList_itemSelectionChanged" ID="FindFileFiltersEditDialog.on_fileFiltersList_itemSelectionChanged"></a> +<h4>FindFileFiltersEditDialog.on_fileFiltersList_itemSelectionChanged</h4> +<b>on_fileFiltersList_itemSelectionChanged</b>(<i></i>) +<p> + Private slot to handle a change of the selected items. +</p> + +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html>