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