Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog.html
eric6/Documentation/Source/eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog.html
- changeset 7273
- 391d6b7b1eff
- parent 6942
- 2602857055c5
- child 7634
- 8c3d033e5044
equal
deleted
inserted
replaced
| 7272:1779dc278077 | 7273:391d6b7b1eff |
|---|---|
| 16 | 16 |
| 17 a { color: #BA6D36; } | 17 a { color: #BA6D36; } |
| 18 | 18 |
| 19 </style> | 19 </style> |
| 20 </head> | 20 </head> |
| 21 <body><a NAME="top" ID="top"></a> | 21 <body> |
| 22 <a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog</h1> | 23 <h1>eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog</h1> |
| 24 | |
| 23 <p> | 25 <p> |
| 24 Module implementing a dialog to select QtHelp documentation sets to be | 26 Module implementing a dialog to select QtHelp documentation sets to be |
| 25 installed. | 27 installed. |
| 26 </p> | 28 </p> |
| 27 <h3>Global Attributes</h3> | 29 <h3>Global Attributes</h3> |
| 30 | |
| 28 <table> | 31 <table> |
| 29 <tr><td>None</td></tr> | 32 <tr><td>None</td></tr> |
| 30 </table> | 33 </table> |
| 31 <h3>Classes</h3> | 34 <h3>Classes</h3> |
| 35 | |
| 32 <table> | 36 <table> |
| 37 | |
| 33 <tr> | 38 <tr> |
| 34 <td><a href="#QtHelpDocumentationSelectionDialog">QtHelpDocumentationSelectionDialog</a></td> | 39 <td><a href="#QtHelpDocumentationSelectionDialog">QtHelpDocumentationSelectionDialog</a></td> |
| 35 <td>Class implementing a dialog to select QtHelp documentation sets to be installed.</td> | 40 <td>Class implementing a dialog to select QtHelp documentation sets to be installed.</td> |
| 36 </tr> | 41 </tr> |
| 37 </table> | 42 </table> |
| 38 <h3>Functions</h3> | 43 <h3>Functions</h3> |
| 44 | |
| 39 <table> | 45 <table> |
| 40 <tr><td>None</td></tr> | 46 <tr><td>None</td></tr> |
| 41 </table> | 47 </table> |
| 42 <hr /><hr /> | 48 <hr /> |
| 49 <hr /> | |
| 43 <a NAME="QtHelpDocumentationSelectionDialog" ID="QtHelpDocumentationSelectionDialog"></a> | 50 <a NAME="QtHelpDocumentationSelectionDialog" ID="QtHelpDocumentationSelectionDialog"></a> |
| 44 <h2>QtHelpDocumentationSelectionDialog</h2> | 51 <h2>QtHelpDocumentationSelectionDialog</h2> |
| 52 | |
| 45 <p> | 53 <p> |
| 46 Class implementing a dialog to select QtHelp documentation sets to be | 54 Class implementing a dialog to select QtHelp documentation sets to be |
| 47 installed. | 55 installed. |
| 48 </p> | 56 </p> |
| 49 <h3>Derived from</h3> | 57 <h3>Derived from</h3> |
| 50 QDialog, Ui_QtHelpDocumentationSelectionDialog | 58 QDialog, Ui_QtHelpDocumentationSelectionDialog |
| 51 <h3>Class Attributes</h3> | 59 <h3>Class Attributes</h3> |
| 60 | |
| 52 <table> | 61 <table> |
| 53 <tr><td>AddMode</td></tr><tr><td>ManageMode</td></tr> | 62 <tr><td>AddMode</td></tr><tr><td>ManageMode</td></tr> |
| 54 </table> | 63 </table> |
| 55 <h3>Class Methods</h3> | 64 <h3>Class Methods</h3> |
| 65 | |
| 56 <table> | 66 <table> |
| 57 <tr><td>None</td></tr> | 67 <tr><td>None</td></tr> |
| 58 </table> | 68 </table> |
| 59 <h3>Methods</h3> | 69 <h3>Methods</h3> |
| 70 | |
| 60 <table> | 71 <table> |
| 72 | |
| 61 <tr> | 73 <tr> |
| 62 <td><a href="#QtHelpDocumentationSelectionDialog.__init__">QtHelpDocumentationSelectionDialog</a></td> | 74 <td><a href="#QtHelpDocumentationSelectionDialog.__init__">QtHelpDocumentationSelectionDialog</a></td> |
| 63 <td>Constructor</td> | 75 <td>Constructor</td> |
| 64 </tr><tr> | 76 </tr> |
| 77 <tr> | |
| 65 <td><a href="#QtHelpDocumentationSelectionDialog.__deleteCategory">__deleteCategory</a></td> | 78 <td><a href="#QtHelpDocumentationSelectionDialog.__deleteCategory">__deleteCategory</a></td> |
| 66 <td>Private method to delete a category.</td> | 79 <td>Private method to delete a category.</td> |
| 67 </tr><tr> | 80 </tr> |
| 81 <tr> | |
| 68 <td><a href="#QtHelpDocumentationSelectionDialog.getData">getData</a></td> | 82 <td><a href="#QtHelpDocumentationSelectionDialog.getData">getData</a></td> |
| 69 <td>Public method to retrieve the selected help documents.</td> | 83 <td>Public method to retrieve the selected help documents.</td> |
| 70 </tr><tr> | 84 </tr> |
| 85 <tr> | |
| 71 <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked">on_deleteAllButton_clicked</a></td> | 86 <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked">on_deleteAllButton_clicked</a></td> |
| 72 <td>Private slot to delete all documentation sets.</td> | 87 <td>Private slot to delete all documentation sets.</td> |
| 73 </tr><tr> | 88 </tr> |
| 89 <tr> | |
| 74 <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> | 90 <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> |
| 75 <td>Private slot to delete the selected documentation sets.</td> | 91 <td>Private slot to delete the selected documentation sets.</td> |
| 76 </tr><tr> | 92 </tr> |
| 93 <tr> | |
| 77 <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked">on_deleteCategoryButton_clicked</a></td> | 94 <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked">on_deleteCategoryButton_clicked</a></td> |
| 78 <td>Private slot to delete the selected documentation set categories.</td> | 95 <td>Private slot to delete the selected documentation set categories.</td> |
| 79 </tr><tr> | 96 </tr> |
| 97 <tr> | |
| 80 <td><a href="#QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged">on_documentationList_itemSelectionChanged</a></td> | 98 <td><a href="#QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged">on_documentationList_itemSelectionChanged</a></td> |
| 81 <td>Private slot handling the selection of items.</td> | 99 <td>Private slot handling the selection of items.</td> |
| 82 </tr> | 100 </tr> |
| 83 </table> | 101 </table> |
| 84 <h3>Static Methods</h3> | 102 <h3>Static Methods</h3> |
| 103 | |
| 85 <table> | 104 <table> |
| 86 <tr><td>None</td></tr> | 105 <tr><td>None</td></tr> |
| 87 </table> | 106 </table> |
| 107 | |
| 88 <a NAME="QtHelpDocumentationSelectionDialog.__init__" ID="QtHelpDocumentationSelectionDialog.__init__"></a> | 108 <a NAME="QtHelpDocumentationSelectionDialog.__init__" ID="QtHelpDocumentationSelectionDialog.__init__"></a> |
| 89 <h4>QtHelpDocumentationSelectionDialog (Constructor)</h4> | 109 <h4>QtHelpDocumentationSelectionDialog (Constructor)</h4> |
| 90 <b>QtHelpDocumentationSelectionDialog</b>(<i>helpDocuments, mode, parent=None</i>) | 110 <b>QtHelpDocumentationSelectionDialog</b>(<i>helpDocuments, mode, parent=None</i>) |
| 111 | |
| 91 <p> | 112 <p> |
| 92 Constructor | 113 Constructor |
| 93 </p><dl> | 114 </p> |
| 115 <dl> | |
| 116 | |
| 94 <dt><i>helpDocuments</i> (dict of lists of str)</dt> | 117 <dt><i>helpDocuments</i> (dict of lists of str)</dt> |
| 95 <dd> | 118 <dd> |
| 96 dictionary containing the lists of help documents | 119 dictionary containing the lists of help documents |
| 97 to be shown | 120 to be shown |
| 98 </dd><dt><i>mode</i> (str)</dt> | 121 </dd> |
| 122 <dt><i>mode</i> (str)</dt> | |
| 99 <dd> | 123 <dd> |
| 100 mode of the dialog | 124 mode of the dialog |
| 101 </dd><dt><i>parent</i> (QWidget)</dt> | 125 </dd> |
| 126 <dt><i>parent</i> (QWidget)</dt> | |
| 102 <dd> | 127 <dd> |
| 103 reference to the parent widget | 128 reference to the parent widget |
| 104 </dd> | 129 </dd> |
| 105 </dl><a NAME="QtHelpDocumentationSelectionDialog.__deleteCategory" ID="QtHelpDocumentationSelectionDialog.__deleteCategory"></a> | 130 </dl> |
| 131 <a NAME="QtHelpDocumentationSelectionDialog.__deleteCategory" ID="QtHelpDocumentationSelectionDialog.__deleteCategory"></a> | |
| 106 <h4>QtHelpDocumentationSelectionDialog.__deleteCategory</h4> | 132 <h4>QtHelpDocumentationSelectionDialog.__deleteCategory</h4> |
| 107 <b>__deleteCategory</b>(<i>category</i>) | 133 <b>__deleteCategory</b>(<i>category</i>) |
| 134 | |
| 108 <p> | 135 <p> |
| 109 Private method to delete a category. | 136 Private method to delete a category. |
| 110 </p><dl> | 137 </p> |
| 138 <dl> | |
| 139 | |
| 111 <dt><i>category</i> (QTreeWidgetItem)</dt> | 140 <dt><i>category</i> (QTreeWidgetItem)</dt> |
| 112 <dd> | 141 <dd> |
| 113 reference to the category item | 142 reference to the category item |
| 114 </dd> | 143 </dd> |
| 115 </dl><a NAME="QtHelpDocumentationSelectionDialog.getData" ID="QtHelpDocumentationSelectionDialog.getData"></a> | 144 </dl> |
| 145 <a NAME="QtHelpDocumentationSelectionDialog.getData" ID="QtHelpDocumentationSelectionDialog.getData"></a> | |
| 116 <h4>QtHelpDocumentationSelectionDialog.getData</h4> | 146 <h4>QtHelpDocumentationSelectionDialog.getData</h4> |
| 117 <b>getData</b>(<i></i>) | 147 <b>getData</b>(<i></i>) |
| 148 | |
| 118 <p> | 149 <p> |
| 119 Public method to retrieve the selected help documents. | 150 Public method to retrieve the selected help documents. |
| 120 </p><dl> | 151 </p> |
| 152 <dl> | |
| 121 <dt>Returns:</dt> | 153 <dt>Returns:</dt> |
| 122 <dd> | 154 <dd> |
| 123 list of QtHelp documentation sets to be installed | 155 list of QtHelp documentation sets to be installed |
| 124 </dd> | 156 </dd> |
| 125 </dl><dl> | 157 </dl> |
| 158 <dl> | |
| 126 <dt>Return Type:</dt> | 159 <dt>Return Type:</dt> |
| 127 <dd> | 160 <dd> |
| 128 list of str | 161 list of str |
| 129 </dd> | 162 </dd> |
| 130 </dl><a NAME="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked"></a> | 163 </dl> |
| 164 <a NAME="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked"></a> | |
| 131 <h4>QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked</h4> | 165 <h4>QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked</h4> |
| 132 <b>on_deleteAllButton_clicked</b>(<i></i>) | 166 <b>on_deleteAllButton_clicked</b>(<i></i>) |
| 167 | |
| 133 <p> | 168 <p> |
| 134 Private slot to delete all documentation sets. | 169 Private slot to delete all documentation sets. |
| 135 </p><a NAME="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked"></a> | 170 </p> |
| 171 <a NAME="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked"></a> | |
| 136 <h4>QtHelpDocumentationSelectionDialog.on_deleteButton_clicked</h4> | 172 <h4>QtHelpDocumentationSelectionDialog.on_deleteButton_clicked</h4> |
| 137 <b>on_deleteButton_clicked</b>(<i></i>) | 173 <b>on_deleteButton_clicked</b>(<i></i>) |
| 174 | |
| 138 <p> | 175 <p> |
| 139 Private slot to delete the selected documentation sets. | 176 Private slot to delete the selected documentation sets. |
| 140 </p><a NAME="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked"></a> | 177 </p> |
| 178 <a NAME="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked"></a> | |
| 141 <h4>QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked</h4> | 179 <h4>QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked</h4> |
| 142 <b>on_deleteCategoryButton_clicked</b>(<i></i>) | 180 <b>on_deleteCategoryButton_clicked</b>(<i></i>) |
| 181 | |
| 143 <p> | 182 <p> |
| 144 Private slot to delete the selected documentation set categories. | 183 Private slot to delete the selected documentation set categories. |
| 145 </p><a NAME="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged" ID="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged"></a> | 184 </p> |
| 185 <a NAME="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged" ID="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged"></a> | |
| 146 <h4>QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged</h4> | 186 <h4>QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged</h4> |
| 147 <b>on_documentationList_itemSelectionChanged</b>(<i></i>) | 187 <b>on_documentationList_itemSelectionChanged</b>(<i></i>) |
| 188 | |
| 148 <p> | 189 <p> |
| 149 Private slot handling the selection of items. | 190 Private slot handling the selection of items. |
| 150 </p> | 191 </p> |
| 151 <div align="right"><a href="#top">Up</a></div> | 192 <div align="right"><a href="#top">Up</a></div> |
| 152 <hr /> | 193 <hr /> |
