--- a/eric6/Documentation/Source/eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog.html Wed Sep 25 19:40:31 2019 +0200 +++ b/eric6/Documentation/Source/eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog.html Wed Sep 25 19:42:44 2019 +0200 @@ -18,30 +18,38 @@ </style> </head> -<body><a NAME="top" ID="top"></a> +<body> +<a NAME="top" ID="top"></a> <h1>eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog</h1> + <p> Module implementing a dialog to select QtHelp documentation sets to be installed. </p> <h3>Global Attributes</h3> + <table> <tr><td>None</td></tr> </table> <h3>Classes</h3> + <table> + <tr> <td><a href="#QtHelpDocumentationSelectionDialog">QtHelpDocumentationSelectionDialog</a></td> <td>Class implementing a dialog to select QtHelp documentation sets to be installed.</td> </tr> </table> <h3>Functions</h3> + <table> <tr><td>None</td></tr> </table> -<hr /><hr /> +<hr /> +<hr /> <a NAME="QtHelpDocumentationSelectionDialog" ID="QtHelpDocumentationSelectionDialog"></a> <h2>QtHelpDocumentationSelectionDialog</h2> + <p> Class implementing a dialog to select QtHelp documentation sets to be installed. @@ -49,102 +57,135 @@ <h3>Derived from</h3> QDialog, Ui_QtHelpDocumentationSelectionDialog <h3>Class Attributes</h3> + <table> <tr><td>AddMode</td></tr><tr><td>ManageMode</td></tr> </table> <h3>Class Methods</h3> + <table> <tr><td>None</td></tr> </table> <h3>Methods</h3> + <table> + <tr> <td><a href="#QtHelpDocumentationSelectionDialog.__init__">QtHelpDocumentationSelectionDialog</a></td> <td>Constructor</td> -</tr><tr> +</tr> +<tr> <td><a href="#QtHelpDocumentationSelectionDialog.__deleteCategory">__deleteCategory</a></td> <td>Private method to delete a category.</td> -</tr><tr> +</tr> +<tr> <td><a href="#QtHelpDocumentationSelectionDialog.getData">getData</a></td> <td>Public method to retrieve the selected help documents.</td> -</tr><tr> +</tr> +<tr> <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked">on_deleteAllButton_clicked</a></td> <td>Private slot to delete all documentation sets.</td> -</tr><tr> +</tr> +<tr> <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> <td>Private slot to delete the selected documentation sets.</td> -</tr><tr> +</tr> +<tr> <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked">on_deleteCategoryButton_clicked</a></td> <td>Private slot to delete the selected documentation set categories.</td> -</tr><tr> +</tr> +<tr> <td><a href="#QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged">on_documentationList_itemSelectionChanged</a></td> <td>Private slot handling the selection of items.</td> </tr> </table> <h3>Static Methods</h3> + <table> <tr><td>None</td></tr> </table> + <a NAME="QtHelpDocumentationSelectionDialog.__init__" ID="QtHelpDocumentationSelectionDialog.__init__"></a> <h4>QtHelpDocumentationSelectionDialog (Constructor)</h4> <b>QtHelpDocumentationSelectionDialog</b>(<i>helpDocuments, mode, parent=None</i>) + <p> Constructor -</p><dl> +</p> +<dl> + <dt><i>helpDocuments</i> (dict of lists of str)</dt> <dd> dictionary containing the lists of help documents to be shown -</dd><dt><i>mode</i> (str)</dt> +</dd> +<dt><i>mode</i> (str)</dt> <dd> mode of the dialog -</dd><dt><i>parent</i> (QWidget)</dt> +</dd> +<dt><i>parent</i> (QWidget)</dt> <dd> reference to the parent widget </dd> -</dl><a NAME="QtHelpDocumentationSelectionDialog.__deleteCategory" ID="QtHelpDocumentationSelectionDialog.__deleteCategory"></a> +</dl> +<a NAME="QtHelpDocumentationSelectionDialog.__deleteCategory" ID="QtHelpDocumentationSelectionDialog.__deleteCategory"></a> <h4>QtHelpDocumentationSelectionDialog.__deleteCategory</h4> <b>__deleteCategory</b>(<i>category</i>) + <p> Private method to delete a category. -</p><dl> +</p> +<dl> + <dt><i>category</i> (QTreeWidgetItem)</dt> <dd> reference to the category item </dd> -</dl><a NAME="QtHelpDocumentationSelectionDialog.getData" ID="QtHelpDocumentationSelectionDialog.getData"></a> +</dl> +<a NAME="QtHelpDocumentationSelectionDialog.getData" ID="QtHelpDocumentationSelectionDialog.getData"></a> <h4>QtHelpDocumentationSelectionDialog.getData</h4> <b>getData</b>(<i></i>) + <p> Public method to retrieve the selected help documents. -</p><dl> +</p> +<dl> <dt>Returns:</dt> <dd> list of QtHelp documentation sets to be installed </dd> -</dl><dl> +</dl> +<dl> <dt>Return Type:</dt> <dd> list of str </dd> -</dl><a NAME="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked"></a> +</dl> +<a NAME="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked"></a> <h4>QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked</h4> <b>on_deleteAllButton_clicked</b>(<i></i>) + <p> Private slot to delete all documentation sets. -</p><a NAME="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked"></a> +</p> +<a NAME="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked"></a> <h4>QtHelpDocumentationSelectionDialog.on_deleteButton_clicked</h4> <b>on_deleteButton_clicked</b>(<i></i>) + <p> Private slot to delete the selected documentation sets. -</p><a NAME="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked"></a> +</p> +<a NAME="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked"></a> <h4>QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked</h4> <b>on_deleteCategoryButton_clicked</b>(<i></i>) + <p> Private slot to delete the selected documentation set categories. -</p><a NAME="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged" ID="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged"></a> +</p> +<a NAME="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged" ID="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged"></a> <h4>QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged</h4> <b>on_documentationList_itemSelectionChanged</b>(<i></i>) + <p> Private slot handling the selection of items. </p>