diff -r 1779dc278077 -r 391d6b7b1eff eric6/Documentation/Source/eric6.Preferences.SubstyleDefinitionDialog.html --- a/eric6/Documentation/Source/eric6.Preferences.SubstyleDefinitionDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.Preferences.SubstyleDefinitionDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,133 +18,175 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.Preferences.SubstyleDefinitionDialog</h1> + <p> Module implementing the sub-style definition dialog. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#SubstyleDefinitionDialog">SubstyleDefinitionDialog</a></td> <td>Class implementing the sub-style definition dialog.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="SubstyleDefinitionDialog" ID="SubstyleDefinitionDialog"></a> <h2>SubstyleDefinitionDialog</h2> + <p> Class implementing the sub-style definition dialog. </p> <h3>Derived from</h3> QDialog, Ui_SubstyleDefinitionDialog <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="#SubstyleDefinitionDialog.__init__">SubstyleDefinitionDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#SubstyleDefinitionDialog.__updateOk">__updateOk</a></td> <td>Private slot to update the state of the OK button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SubstyleDefinitionDialog.getData">getData</a></td> <td>Public method to get the entered data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SubstyleDefinitionDialog.on_defaultButton_clicked">on_defaultButton_clicked</a></td> <td>Private slot to set the dialog contents to default values.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SubstyleDefinitionDialog.on_descriptionEdit_textChanged">on_descriptionEdit_textChanged</a></td> <td>Private slot handling changes of the description.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SubstyleDefinitionDialog.on_resetButton_clicked">on_resetButton_clicked</a></td> <td>Private slot to reset the dialog contents.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SubstyleDefinitionDialog.on_wordsEdit_textChanged">on_wordsEdit_textChanged</a></td> <td>Private slot handling changes of the word list.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="SubstyleDefinitionDialog.__init__" ID="SubstyleDefinitionDialog.__init__"></a> <h4>SubstyleDefinitionDialog (Constructor)</h4> <b>SubstyleDefinitionDialog</b>(<i>lexer, style, substyle, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>lexer</i> (PreferencesLexer)</dt> <dd> reference to the lexer object -</dd><dt><i>style</i> (int)</dt> +</dd> +<dt><i>style</i> (int)</dt> <dd> style number -</dd><dt><i>substyle</i> (int)</dt> +</dd> +<dt><i>substyle</i> (int)</dt> <dd> sub-style number -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="SubstyleDefinitionDialog.__updateOk" ID="SubstyleDefinitionDialog.__updateOk"></a> +</dl> +<a NAME="SubstyleDefinitionDialog.__updateOk" ID="SubstyleDefinitionDialog.__updateOk"></a> <h4>SubstyleDefinitionDialog.__updateOk</h4> <b>__updateOk</b>(<i></i>) + <p> Private slot to update the state of the OK button. -</p><a NAME="SubstyleDefinitionDialog.getData" ID="SubstyleDefinitionDialog.getData"></a> +</p> +<a NAME="SubstyleDefinitionDialog.getData" ID="SubstyleDefinitionDialog.getData"></a> <h4>SubstyleDefinitionDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public method to get the entered data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple containing the sub-style description and words list. </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> tuple of (str, str) </dd> -</dl><a NAME="SubstyleDefinitionDialog.on_defaultButton_clicked" ID="SubstyleDefinitionDialog.on_defaultButton_clicked"></a> +</dl> +<a NAME="SubstyleDefinitionDialog.on_defaultButton_clicked" ID="SubstyleDefinitionDialog.on_defaultButton_clicked"></a> <h4>SubstyleDefinitionDialog.on_defaultButton_clicked</h4> <b>on_defaultButton_clicked</b>(<i></i>) + <p> Private slot to set the dialog contents to default values. -</p><a NAME="SubstyleDefinitionDialog.on_descriptionEdit_textChanged" ID="SubstyleDefinitionDialog.on_descriptionEdit_textChanged"></a> +</p> +<a NAME="SubstyleDefinitionDialog.on_descriptionEdit_textChanged" ID="SubstyleDefinitionDialog.on_descriptionEdit_textChanged"></a> <h4>SubstyleDefinitionDialog.on_descriptionEdit_textChanged</h4> <b>on_descriptionEdit_textChanged</b>(<i>txt</i>) + <p> Private slot handling changes of the description. -</p><dl> +</p> +<dl> + <dt><i>txt</i> (str)</dt> <dd> text of the description </dd> -</dl><a NAME="SubstyleDefinitionDialog.on_resetButton_clicked" ID="SubstyleDefinitionDialog.on_resetButton_clicked"></a> +</dl> +<a NAME="SubstyleDefinitionDialog.on_resetButton_clicked" ID="SubstyleDefinitionDialog.on_resetButton_clicked"></a> <h4>SubstyleDefinitionDialog.on_resetButton_clicked</h4> <b>on_resetButton_clicked</b>(<i></i>) + <p> Private slot to reset the dialog contents. -</p><a NAME="SubstyleDefinitionDialog.on_wordsEdit_textChanged" ID="SubstyleDefinitionDialog.on_wordsEdit_textChanged"></a> +</p> +<a NAME="SubstyleDefinitionDialog.on_wordsEdit_textChanged" ID="SubstyleDefinitionDialog.on_wordsEdit_textChanged"></a> <h4>SubstyleDefinitionDialog.on_wordsEdit_textChanged</h4> <b>on_wordsEdit_textChanged</b>(<i></i>) + <p> Private slot handling changes of the word list. </p>