--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleAddBuiltinIgnoreDialog.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,156 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleAddBuiltinIgnoreDialog</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Plugins.CheckerPlugins.CodeStyleChecker.CodeStyleAddBuiltinIgnoreDialog</h1> + +<p> +Module implementing a dialog to enter the data for a built-in assignment to +be ignored. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#CodeStyleAddBuiltinIgnoreDialog">CodeStyleAddBuiltinIgnoreDialog</a></td> +<td>Class implementing a dialog to enter the data for a built-in assignment to be ignored.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="CodeStyleAddBuiltinIgnoreDialog" ID="CodeStyleAddBuiltinIgnoreDialog"></a> +<h2>CodeStyleAddBuiltinIgnoreDialog</h2> + +<p> + Class implementing a dialog to enter the data for a built-in assignment to + be ignored. +</p> +<h3>Derived from</h3> +QDialog, Ui_CodeStyleAddBuiltinIgnoreDialog +<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="#CodeStyleAddBuiltinIgnoreDialog.__init__">CodeStyleAddBuiltinIgnoreDialog</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#CodeStyleAddBuiltinIgnoreDialog.__updateOkButton">__updateOkButton</a></td> +<td>Private slot to set the state of the OK button.</td> +</tr> +<tr> +<td><a href="#CodeStyleAddBuiltinIgnoreDialog.getData">getData</a></td> +<td>Public method to get the entered data.</td> +</tr> +<tr> +<td><a href="#CodeStyleAddBuiltinIgnoreDialog.on_leftEdit_textChanged">on_leftEdit_textChanged</a></td> +<td>Private slot to handle a change of the text of the left side edit.</td> +</tr> +<tr> +<td><a href="#CodeStyleAddBuiltinIgnoreDialog.on_rightEdit_textChanged">on_rightEdit_textChanged</a></td> +<td>Private slot to handle a change of the text of the right side edit.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="CodeStyleAddBuiltinIgnoreDialog.__init__" ID="CodeStyleAddBuiltinIgnoreDialog.__init__"></a> +<h4>CodeStyleAddBuiltinIgnoreDialog (Constructor)</h4> +<b>CodeStyleAddBuiltinIgnoreDialog</b>(<i>parent=None</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QWidget)</dt> +<dd> +reference to the parent widget +</dd> +</dl> +<a NAME="CodeStyleAddBuiltinIgnoreDialog.__updateOkButton" ID="CodeStyleAddBuiltinIgnoreDialog.__updateOkButton"></a> +<h4>CodeStyleAddBuiltinIgnoreDialog.__updateOkButton</h4> +<b>__updateOkButton</b>(<i></i>) + +<p> + Private slot to set the state of the OK button. +</p> +<a NAME="CodeStyleAddBuiltinIgnoreDialog.getData" ID="CodeStyleAddBuiltinIgnoreDialog.getData"></a> +<h4>CodeStyleAddBuiltinIgnoreDialog.getData</h4> +<b>getData</b>(<i></i>) + +<p> + Public method to get the entered data. +</p> +<dl> +<dt>Return:</dt> +<dd> +tuple containing the left and right hand side of the assignment +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of two str +</dd> +</dl> +<a NAME="CodeStyleAddBuiltinIgnoreDialog.on_leftEdit_textChanged" ID="CodeStyleAddBuiltinIgnoreDialog.on_leftEdit_textChanged"></a> +<h4>CodeStyleAddBuiltinIgnoreDialog.on_leftEdit_textChanged</h4> +<b>on_leftEdit_textChanged</b>(<i>txt</i>) + +<p> + Private slot to handle a change of the text of the left side edit. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +text of the line edit +</dd> +</dl> +<a NAME="CodeStyleAddBuiltinIgnoreDialog.on_rightEdit_textChanged" ID="CodeStyleAddBuiltinIgnoreDialog.on_rightEdit_textChanged"></a> +<h4>CodeStyleAddBuiltinIgnoreDialog.on_rightEdit_textChanged</h4> +<b>on_rightEdit_textChanged</b>(<i>txt</i>) + +<p> + Private slot to handle a change of the text of the right side edit. +</p> +<dl> + +<dt><i>txt</i> (str)</dt> +<dd> +text of the line edit +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file