--- a/PrintRemover/Documentation/source/Plugin_Tools_Print_Remover.PrintRemover.ConfigurationPage.PrintRemoverPage.html Wed Apr 08 19:33:29 2020 +0200 +++ b/PrintRemover/Documentation/source/Plugin_Tools_Print_Remover.PrintRemover.ConfigurationPage.PrintRemoverPage.html Wed Jun 24 17:45:47 2020 +0200 @@ -18,138 +18,184 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Tools_Print_Remover.PrintRemover.ConfigurationPage.PrintRemoverPage</h1> + <p> Module implementing the Print Remover configuration page. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#PrintRemoverPage">PrintRemoverPage</a></td> <td>Class implementing the Print Remover configuration page.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="PrintRemoverPage" ID="PrintRemoverPage"></a> <h2>PrintRemoverPage</h2> + <p> Class implementing the Print Remover configuration page. </p> <h3>Derived from</h3> ConfigurationPageBase, Ui_PrintRemoverPage <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="#PrintRemoverPage.__init__">PrintRemoverPage</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#PrintRemoverPage.__moveSelectedEntry">__moveSelectedEntry</a></td> <td>Private method to move the selected entry up or down.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PrintRemoverPage.on_addButton_clicked">on_addButton_clicked</a></td> <td>Private slot add a pattern to the list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PrintRemoverPage.on_addSeparatorButton_clicked">on_addSeparatorButton_clicked</a></td> <td>Private slot add a separator to the list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PrintRemoverPage.on_deleteButton_clicked">on_deleteButton_clicked</a></td> <td>Private slot to delete the selected entry.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PrintRemoverPage.on_downButton_clicked">on_downButton_clicked</a></td> <td>Private slot to move an entry down.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PrintRemoverPage.on_editButton_clicked">on_editButton_clicked</a></td> <td>Private slot to edit the selected entry.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PrintRemoverPage.on_patternList_itemSelectionChanged">on_patternList_itemSelectionChanged</a></td> <td>Private slot to handle the selection of patterns.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PrintRemoverPage.on_upButton_clicked">on_upButton_clicked</a></td> <td>Private slot to move an entry up.</td> -</tr><tr> +</tr> +<tr> <td><a href="#PrintRemoverPage.save">save</a></td> <td>Public slot to save the Print Remover configuration.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="PrintRemoverPage.__init__" ID="PrintRemoverPage.__init__"></a> <h4>PrintRemoverPage (Constructor)</h4> <b>PrintRemoverPage</b>(<i>plugin</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>plugin</i></dt> <dd> reference to the plugin object </dd> -</dl><a NAME="PrintRemoverPage.__moveSelectedEntry" ID="PrintRemoverPage.__moveSelectedEntry"></a> +</dl> +<a NAME="PrintRemoverPage.__moveSelectedEntry" ID="PrintRemoverPage.__moveSelectedEntry"></a> <h4>PrintRemoverPage.__moveSelectedEntry</h4> <b>__moveSelectedEntry</b>(<i>moveUp</i>) + <p> Private method to move the selected entry up or down. -</p><dl> +</p> +<dl> + <dt><i>moveUp</i></dt> <dd> flag indicating to move the entry up (boolean) </dd> -</dl><a NAME="PrintRemoverPage.on_addButton_clicked" ID="PrintRemoverPage.on_addButton_clicked"></a> +</dl> +<a NAME="PrintRemoverPage.on_addButton_clicked" ID="PrintRemoverPage.on_addButton_clicked"></a> <h4>PrintRemoverPage.on_addButton_clicked</h4> <b>on_addButton_clicked</b>(<i></i>) + <p> Private slot add a pattern to the list. -</p><a NAME="PrintRemoverPage.on_addSeparatorButton_clicked" ID="PrintRemoverPage.on_addSeparatorButton_clicked"></a> +</p> +<a NAME="PrintRemoverPage.on_addSeparatorButton_clicked" ID="PrintRemoverPage.on_addSeparatorButton_clicked"></a> <h4>PrintRemoverPage.on_addSeparatorButton_clicked</h4> <b>on_addSeparatorButton_clicked</b>(<i></i>) + <p> Private slot add a separator to the list. -</p><a NAME="PrintRemoverPage.on_deleteButton_clicked" ID="PrintRemoverPage.on_deleteButton_clicked"></a> +</p> +<a NAME="PrintRemoverPage.on_deleteButton_clicked" ID="PrintRemoverPage.on_deleteButton_clicked"></a> <h4>PrintRemoverPage.on_deleteButton_clicked</h4> <b>on_deleteButton_clicked</b>(<i></i>) + <p> Private slot to delete the selected entry. -</p><a NAME="PrintRemoverPage.on_downButton_clicked" ID="PrintRemoverPage.on_downButton_clicked"></a> +</p> +<a NAME="PrintRemoverPage.on_downButton_clicked" ID="PrintRemoverPage.on_downButton_clicked"></a> <h4>PrintRemoverPage.on_downButton_clicked</h4> <b>on_downButton_clicked</b>(<i></i>) + <p> Private slot to move an entry down. -</p><a NAME="PrintRemoverPage.on_editButton_clicked" ID="PrintRemoverPage.on_editButton_clicked"></a> +</p> +<a NAME="PrintRemoverPage.on_editButton_clicked" ID="PrintRemoverPage.on_editButton_clicked"></a> <h4>PrintRemoverPage.on_editButton_clicked</h4> <b>on_editButton_clicked</b>(<i></i>) + <p> Private slot to edit the selected entry. -</p><a NAME="PrintRemoverPage.on_patternList_itemSelectionChanged" ID="PrintRemoverPage.on_patternList_itemSelectionChanged"></a> +</p> +<a NAME="PrintRemoverPage.on_patternList_itemSelectionChanged" ID="PrintRemoverPage.on_patternList_itemSelectionChanged"></a> <h4>PrintRemoverPage.on_patternList_itemSelectionChanged</h4> <b>on_patternList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to handle the selection of patterns. -</p><a NAME="PrintRemoverPage.on_upButton_clicked" ID="PrintRemoverPage.on_upButton_clicked"></a> +</p> +<a NAME="PrintRemoverPage.on_upButton_clicked" ID="PrintRemoverPage.on_upButton_clicked"></a> <h4>PrintRemoverPage.on_upButton_clicked</h4> <b>on_upButton_clicked</b>(<i></i>) + <p> Private slot to move an entry up. -</p><a NAME="PrintRemoverPage.save" ID="PrintRemoverPage.save"></a> +</p> +<a NAME="PrintRemoverPage.save" ID="PrintRemoverPage.save"></a> <h4>PrintRemoverPage.save</h4> <b>save</b>(<i></i>) + <p> Public slot to save the Print Remover configuration. </p>