diff -r e534c4399087 -r e747eb5f3f43 SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.SelectionEncloser.ConfigurationPage.SelectionEncloserEditDialog.html --- a/SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.SelectionEncloser.ConfigurationPage.SelectionEncloserEditDialog.html Wed Apr 08 19:22:28 2020 +0200 +++ b/SelectionEncloser/Documentation/source/Plugin_Tools_Selection_Encloser.SelectionEncloser.ConfigurationPage.SelectionEncloserEditDialog.html Wed Jun 24 17:36:34 2020 +0200 @@ -18,113 +18,149 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Tools_Selection_Encloser.SelectionEncloser.ConfigurationPage.SelectionEncloserEditDialog</h1> + <p> Module implementing a dialog to edit an enclosing menu entry. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#SelectionEncloserEditDialog">SelectionEncloserEditDialog</a></td> <td>Class implementing a dialog to edit an enclosing menu entry.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="SelectionEncloserEditDialog" ID="SelectionEncloserEditDialog"></a> <h2>SelectionEncloserEditDialog</h2> + <p> Class implementing a dialog to edit an enclosing menu entry. </p> <h3>Derived from</h3> QDialog, Ui_SelectionEncloserEditDialog <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="#SelectionEncloserEditDialog.__init__">SelectionEncloserEditDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#SelectionEncloserEditDialog.__updateOkButton">__updateOkButton</a></td> <td>Private slot to set the status of the OK button.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SelectionEncloserEditDialog.getData">getData</a></td> <td>Public method to get the dialog data.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SelectionEncloserEditDialog.on_stringEdit_textChanged">on_stringEdit_textChanged</a></td> <td>Private slot to react on changes of the string.</td> -</tr><tr> +</tr> +<tr> <td><a href="#SelectionEncloserEditDialog.on_titleEdit_textChanged">on_titleEdit_textChanged</a></td> <td>Private slot to react on changes of the title.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="SelectionEncloserEditDialog.__init__" ID="SelectionEncloserEditDialog.__init__"></a> <h4>SelectionEncloserEditDialog (Constructor)</h4> <b>SelectionEncloserEditDialog</b>(<i>title="", string="", parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>title</i></dt> <dd> menu entry title (string) -</dd><dt><i>string</i></dt> +</dd> +<dt><i>string</i></dt> <dd> enclosing string or string format expression (string) -</dd><dt><i>parent</i></dt> +</dd> +<dt><i>parent</i></dt> <dd> reference to the parent widget (QWidget) </dd> -</dl><a NAME="SelectionEncloserEditDialog.__updateOkButton" ID="SelectionEncloserEditDialog.__updateOkButton"></a> +</dl> +<a NAME="SelectionEncloserEditDialog.__updateOkButton" ID="SelectionEncloserEditDialog.__updateOkButton"></a> <h4>SelectionEncloserEditDialog.__updateOkButton</h4> <b>__updateOkButton</b>(<i></i>) + <p> Private slot to set the status of the OK button. -</p><a NAME="SelectionEncloserEditDialog.getData" ID="SelectionEncloserEditDialog.getData"></a> +</p> +<a NAME="SelectionEncloserEditDialog.getData" ID="SelectionEncloserEditDialog.getData"></a> <h4>SelectionEncloserEditDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public method to get the dialog data. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> tuple with menu entry title (string) and enclosing string or string format expression (string) </dd> -</dl><a NAME="SelectionEncloserEditDialog.on_stringEdit_textChanged" ID="SelectionEncloserEditDialog.on_stringEdit_textChanged"></a> +</dl> +<a NAME="SelectionEncloserEditDialog.on_stringEdit_textChanged" ID="SelectionEncloserEditDialog.on_stringEdit_textChanged"></a> <h4>SelectionEncloserEditDialog.on_stringEdit_textChanged</h4> <b>on_stringEdit_textChanged</b>(<i>txt</i>) + <p> Private slot to react on changes of the string. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> enclosing string (string) </dd> -</dl><a NAME="SelectionEncloserEditDialog.on_titleEdit_textChanged" ID="SelectionEncloserEditDialog.on_titleEdit_textChanged"></a> +</dl> +<a NAME="SelectionEncloserEditDialog.on_titleEdit_textChanged" ID="SelectionEncloserEditDialog.on_titleEdit_textChanged"></a> <h4>SelectionEncloserEditDialog.on_titleEdit_textChanged</h4> <b>on_titleEdit_textChanged</b>(<i>txt</i>) + <p> Private slot to react on changes of the title. -</p><dl> +</p> +<dl> + <dt><i>txt</i></dt> <dd> title text (string)