--- a/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.EditWhiteListDialog.html Wed Jan 01 11:58:52 2020 +0100 +++ b/VultureChecker/Documentation/source/Plugin_Checker_Vulture.VultureChecker.EditWhiteListDialog.html Tue Jun 23 17:33:21 2020 +0200 @@ -18,239 +18,317 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>Plugin_Checker_Vulture.VultureChecker.EditWhiteListDialog</h1> + <p> Module implementing the whitelist edit dialog. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#EditWhiteListDialog">EditWhiteListDialog</a></td> <td>Class implementing the whitelist edit dialog.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="EditWhiteListDialog" ID="EditWhiteListDialog"></a> <h2>EditWhiteListDialog</h2> + <p> Class implementing the whitelist edit dialog. </p> <h3>Derived from</h3> QDialog, Ui_EditWhiteListDialog <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="#EditWhiteListDialog.__init__">EditWhiteListDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.__getWhiteList">__getWhiteList</a></td> <td>Private method to get the whitelisted names from a list widget.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.__isPattern">__isPattern</a></td> <td>Private method to check, if a name is a wildcard pattern.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.__setButtonEnabledStates">__setButtonEnabledStates</a></td> <td>Private slot to set the state of various buttons.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.getWhiteLists">getWhiteLists</a></td> <td>Public methods to retrieve the various whitelists.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_addButton_clicked">on_addButton_clicked</a></td> <td>Private slot to add an entry to the current list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_attributesList_itemSelectionChanged">on_attributesList_itemSelectionChanged</a></td> <td>Private slot to react upon a change of selection in the attributes list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_classesList_itemSelectionChanged">on_classesList_itemSelectionChanged</a></td> <td>Private slot to react upon a change of selection in the classes list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_functionsList_itemSelectionChanged">on_functionsList_itemSelectionChanged</a></td> <td>Private slot to react upon a change of selection in the functions list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_importsList_itemSelectionChanged">on_importsList_itemSelectionChanged</a></td> <td>Private slot to react upon a change of selection in the imports list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_listsWidget_currentChanged">on_listsWidget_currentChanged</a></td> <td>Private slot handling the selection of tab.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_patternsList_itemSelectionChanged">on_patternsList_itemSelectionChanged</a></td> <td>Private slot to react upon a change of selection in the patterns list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_propertiesList_itemSelectionChanged">on_propertiesList_itemSelectionChanged</a></td> <td>Private slot to react upon a change of selection in the properties list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_removeAllButton_clicked">on_removeAllButton_clicked</a></td> <td>Private slot to remove all entries from the current list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> <td>Private slot to remove the selected entries from the current list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_slotsList_itemSelectionChanged">on_slotsList_itemSelectionChanged</a></td> <td>Private slot to react upon a change of selection in the slots list.</td> -</tr><tr> +</tr> +<tr> <td><a href="#EditWhiteListDialog.on_variablesList_itemSelectionChanged">on_variablesList_itemSelectionChanged</a></td> <td>Private slot to react upon a change of selection in the variables list.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="EditWhiteListDialog.__init__" ID="EditWhiteListDialog.__init__"></a> <h4>EditWhiteListDialog (Constructor)</h4> <b>EditWhiteListDialog</b>(<i>whitelists, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>whitelists</i> (dict of list of str)</dt> <dd> dictionary containing the whitelists -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="EditWhiteListDialog.__getWhiteList" ID="EditWhiteListDialog.__getWhiteList"></a> +</dl> +<a NAME="EditWhiteListDialog.__getWhiteList" ID="EditWhiteListDialog.__getWhiteList"></a> <h4>EditWhiteListDialog.__getWhiteList</h4> <b>__getWhiteList</b>(<i>listWidget</i>) + <p> Private method to get the whitelisted names from a list widget. -</p><dl> +</p> +<dl> + <dt><i>listWidget</i> (QListWidget)</dt> <dd> reference to the list widget </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> whitelisted names </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> list of str </dd> -</dl><a NAME="EditWhiteListDialog.__isPattern" ID="EditWhiteListDialog.__isPattern"></a> +</dl> +<a NAME="EditWhiteListDialog.__isPattern" ID="EditWhiteListDialog.__isPattern"></a> <h4>EditWhiteListDialog.__isPattern</h4> <b>__isPattern</b>(<i>name</i>) + <p> Private method to check, if a name is a wildcard pattern. -</p><dl> +</p> +<dl> + <dt><i>name</i> (str)</dt> <dd> name to be checked </dd> -</dl><dl> +</dl> +<dl> <dt>Returns:</dt> <dd> flag indicating a wildcard pattern </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> bool </dd> -</dl><a NAME="EditWhiteListDialog.__setButtonEnabledStates" ID="EditWhiteListDialog.__setButtonEnabledStates"></a> +</dl> +<a NAME="EditWhiteListDialog.__setButtonEnabledStates" ID="EditWhiteListDialog.__setButtonEnabledStates"></a> <h4>EditWhiteListDialog.__setButtonEnabledStates</h4> <b>__setButtonEnabledStates</b>(<i></i>) + <p> Private slot to set the state of various buttons. -</p><a NAME="EditWhiteListDialog.getWhiteLists" ID="EditWhiteListDialog.getWhiteLists"></a> +</p> +<a NAME="EditWhiteListDialog.getWhiteLists" ID="EditWhiteListDialog.getWhiteLists"></a> <h4>EditWhiteListDialog.getWhiteLists</h4> <b>getWhiteLists</b>(<i></i>) + <p> Public methods to retrieve the various whitelists. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> dictionary containing the whitelists </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> dict of list of str </dd> -</dl><a NAME="EditWhiteListDialog.on_addButton_clicked" ID="EditWhiteListDialog.on_addButton_clicked"></a> +</dl> +<a NAME="EditWhiteListDialog.on_addButton_clicked" ID="EditWhiteListDialog.on_addButton_clicked"></a> <h4>EditWhiteListDialog.on_addButton_clicked</h4> <b>on_addButton_clicked</b>(<i></i>) + <p> Private slot to add an entry to the current list. -</p><a NAME="EditWhiteListDialog.on_attributesList_itemSelectionChanged" ID="EditWhiteListDialog.on_attributesList_itemSelectionChanged"></a> +</p> +<a NAME="EditWhiteListDialog.on_attributesList_itemSelectionChanged" ID="EditWhiteListDialog.on_attributesList_itemSelectionChanged"></a> <h4>EditWhiteListDialog.on_attributesList_itemSelectionChanged</h4> <b>on_attributesList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to react upon a change of selection in the attributes list. -</p><a NAME="EditWhiteListDialog.on_classesList_itemSelectionChanged" ID="EditWhiteListDialog.on_classesList_itemSelectionChanged"></a> +</p> +<a NAME="EditWhiteListDialog.on_classesList_itemSelectionChanged" ID="EditWhiteListDialog.on_classesList_itemSelectionChanged"></a> <h4>EditWhiteListDialog.on_classesList_itemSelectionChanged</h4> <b>on_classesList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to react upon a change of selection in the classes list. -</p><a NAME="EditWhiteListDialog.on_functionsList_itemSelectionChanged" ID="EditWhiteListDialog.on_functionsList_itemSelectionChanged"></a> +</p> +<a NAME="EditWhiteListDialog.on_functionsList_itemSelectionChanged" ID="EditWhiteListDialog.on_functionsList_itemSelectionChanged"></a> <h4>EditWhiteListDialog.on_functionsList_itemSelectionChanged</h4> <b>on_functionsList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to react upon a change of selection in the functions list. -</p><a NAME="EditWhiteListDialog.on_importsList_itemSelectionChanged" ID="EditWhiteListDialog.on_importsList_itemSelectionChanged"></a> +</p> +<a NAME="EditWhiteListDialog.on_importsList_itemSelectionChanged" ID="EditWhiteListDialog.on_importsList_itemSelectionChanged"></a> <h4>EditWhiteListDialog.on_importsList_itemSelectionChanged</h4> <b>on_importsList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to react upon a change of selection in the imports list. -</p><a NAME="EditWhiteListDialog.on_listsWidget_currentChanged" ID="EditWhiteListDialog.on_listsWidget_currentChanged"></a> +</p> +<a NAME="EditWhiteListDialog.on_listsWidget_currentChanged" ID="EditWhiteListDialog.on_listsWidget_currentChanged"></a> <h4>EditWhiteListDialog.on_listsWidget_currentChanged</h4> <b>on_listsWidget_currentChanged</b>(<i>index</i>) + <p> Private slot handling the selection of tab. -</p><dl> +</p> +<dl> + <dt><i>index</i> (int)</dt> <dd> index of the selected tab </dd> -</dl><a NAME="EditWhiteListDialog.on_patternsList_itemSelectionChanged" ID="EditWhiteListDialog.on_patternsList_itemSelectionChanged"></a> +</dl> +<a NAME="EditWhiteListDialog.on_patternsList_itemSelectionChanged" ID="EditWhiteListDialog.on_patternsList_itemSelectionChanged"></a> <h4>EditWhiteListDialog.on_patternsList_itemSelectionChanged</h4> <b>on_patternsList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to react upon a change of selection in the patterns list. -</p><a NAME="EditWhiteListDialog.on_propertiesList_itemSelectionChanged" ID="EditWhiteListDialog.on_propertiesList_itemSelectionChanged"></a> +</p> +<a NAME="EditWhiteListDialog.on_propertiesList_itemSelectionChanged" ID="EditWhiteListDialog.on_propertiesList_itemSelectionChanged"></a> <h4>EditWhiteListDialog.on_propertiesList_itemSelectionChanged</h4> <b>on_propertiesList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to react upon a change of selection in the properties list. -</p><a NAME="EditWhiteListDialog.on_removeAllButton_clicked" ID="EditWhiteListDialog.on_removeAllButton_clicked"></a> +</p> +<a NAME="EditWhiteListDialog.on_removeAllButton_clicked" ID="EditWhiteListDialog.on_removeAllButton_clicked"></a> <h4>EditWhiteListDialog.on_removeAllButton_clicked</h4> <b>on_removeAllButton_clicked</b>(<i></i>) + <p> Private slot to remove all entries from the current list. -</p><a NAME="EditWhiteListDialog.on_removeButton_clicked" ID="EditWhiteListDialog.on_removeButton_clicked"></a> +</p> +<a NAME="EditWhiteListDialog.on_removeButton_clicked" ID="EditWhiteListDialog.on_removeButton_clicked"></a> <h4>EditWhiteListDialog.on_removeButton_clicked</h4> <b>on_removeButton_clicked</b>(<i></i>) + <p> Private slot to remove the selected entries from the current list. -</p><a NAME="EditWhiteListDialog.on_slotsList_itemSelectionChanged" ID="EditWhiteListDialog.on_slotsList_itemSelectionChanged"></a> +</p> +<a NAME="EditWhiteListDialog.on_slotsList_itemSelectionChanged" ID="EditWhiteListDialog.on_slotsList_itemSelectionChanged"></a> <h4>EditWhiteListDialog.on_slotsList_itemSelectionChanged</h4> <b>on_slotsList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to react upon a change of selection in the slots list. -</p><a NAME="EditWhiteListDialog.on_variablesList_itemSelectionChanged" ID="EditWhiteListDialog.on_variablesList_itemSelectionChanged"></a> +</p> +<a NAME="EditWhiteListDialog.on_variablesList_itemSelectionChanged" ID="EditWhiteListDialog.on_variablesList_itemSelectionChanged"></a> <h4>EditWhiteListDialog.on_variablesList_itemSelectionChanged</h4> <b>on_variablesList_itemSelectionChanged</b>(<i></i>) + <p> Private slot to react upon a change of selection in the variables list. </p>