Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog.html
eric6/Documentation/Source/eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog.html
- changeset 6942
- 2602857055c5
- parent 5393
- 9db3fd0b1c72
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.WebBrowser.QtHelp.QtHelpDocumentationSelectionDialog</h1> | |
| 23 <p> | |
| 24 Module implementing a dialog to select QtHelp documentation sets to be | |
| 25 installed. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#QtHelpDocumentationSelectionDialog">QtHelpDocumentationSelectionDialog</a></td> | |
| 35 <td>Class implementing a dialog to select QtHelp documentation sets to be installed.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="QtHelpDocumentationSelectionDialog" ID="QtHelpDocumentationSelectionDialog"></a> | |
| 44 <h2>QtHelpDocumentationSelectionDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to select QtHelp documentation sets to be | |
| 47 installed. | |
| 48 </p> | |
| 49 <h3>Derived from</h3> | |
| 50 QDialog, Ui_QtHelpDocumentationSelectionDialog | |
| 51 <h3>Class Attributes</h3> | |
| 52 <table> | |
| 53 <tr><td>AddMode</td></tr><tr><td>ManageMode</td></tr> | |
| 54 </table> | |
| 55 <h3>Class Methods</h3> | |
| 56 <table> | |
| 57 <tr><td>None</td></tr> | |
| 58 </table> | |
| 59 <h3>Methods</h3> | |
| 60 <table> | |
| 61 <tr> | |
| 62 <td><a href="#QtHelpDocumentationSelectionDialog.__init__">QtHelpDocumentationSelectionDialog</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr><tr> | |
| 65 <td><a href="#QtHelpDocumentationSelectionDialog.__deleteCategory">__deleteCategory</a></td> | |
| 66 <td>Private method to delete a category.</td> | |
| 67 </tr><tr> | |
| 68 <td><a href="#QtHelpDocumentationSelectionDialog.getData">getData</a></td> | |
| 69 <td>Public method to retrieve the selected help documents.</td> | |
| 70 </tr><tr> | |
| 71 <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked">on_deleteAllButton_clicked</a></td> | |
| 72 <td>Private slot to delete all documentation sets.</td> | |
| 73 </tr><tr> | |
| 74 <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteButton_clicked">on_deleteButton_clicked</a></td> | |
| 75 <td>Private slot to delete the selected documentation sets.</td> | |
| 76 </tr><tr> | |
| 77 <td><a href="#QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked">on_deleteCategoryButton_clicked</a></td> | |
| 78 <td>Private slot to delete the selected documentation set categories.</td> | |
| 79 </tr><tr> | |
| 80 <td><a href="#QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged">on_documentationList_itemSelectionChanged</a></td> | |
| 81 <td>Private slot handling the selection of items.</td> | |
| 82 </tr> | |
| 83 </table> | |
| 84 <h3>Static Methods</h3> | |
| 85 <table> | |
| 86 <tr><td>None</td></tr> | |
| 87 </table> | |
| 88 <a NAME="QtHelpDocumentationSelectionDialog.__init__" ID="QtHelpDocumentationSelectionDialog.__init__"></a> | |
| 89 <h4>QtHelpDocumentationSelectionDialog (Constructor)</h4> | |
| 90 <b>QtHelpDocumentationSelectionDialog</b>(<i>helpDocuments, mode, parent=None</i>) | |
| 91 <p> | |
| 92 Constructor | |
| 93 </p><dl> | |
| 94 <dt><i>helpDocuments</i> (dict of lists of str)</dt> | |
| 95 <dd> | |
| 96 dictionary containing the lists of help documents | |
| 97 to be shown | |
| 98 </dd><dt><i>mode</i> (str)</dt> | |
| 99 <dd> | |
| 100 mode of the dialog | |
| 101 </dd><dt><i>parent</i> (QWidget)</dt> | |
| 102 <dd> | |
| 103 reference to the parent widget | |
| 104 </dd> | |
| 105 </dl><a NAME="QtHelpDocumentationSelectionDialog.__deleteCategory" ID="QtHelpDocumentationSelectionDialog.__deleteCategory"></a> | |
| 106 <h4>QtHelpDocumentationSelectionDialog.__deleteCategory</h4> | |
| 107 <b>__deleteCategory</b>(<i>category</i>) | |
| 108 <p> | |
| 109 Private method to delete a category. | |
| 110 </p><dl> | |
| 111 <dt><i>category</i> (QTreeWidgetItem)</dt> | |
| 112 <dd> | |
| 113 reference to the category item | |
| 114 </dd> | |
| 115 </dl><a NAME="QtHelpDocumentationSelectionDialog.getData" ID="QtHelpDocumentationSelectionDialog.getData"></a> | |
| 116 <h4>QtHelpDocumentationSelectionDialog.getData</h4> | |
| 117 <b>getData</b>(<i></i>) | |
| 118 <p> | |
| 119 Public method to retrieve the selected help documents. | |
| 120 </p><dl> | |
| 121 <dt>Returns:</dt> | |
| 122 <dd> | |
| 123 list of QtHelp documentation sets to be installed | |
| 124 </dd> | |
| 125 </dl><dl> | |
| 126 <dt>Return Type:</dt> | |
| 127 <dd> | |
| 128 list of str | |
| 129 </dd> | |
| 130 </dl><a NAME="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked"></a> | |
| 131 <h4>QtHelpDocumentationSelectionDialog.on_deleteAllButton_clicked</h4> | |
| 132 <b>on_deleteAllButton_clicked</b>(<i></i>) | |
| 133 <p> | |
| 134 Private slot to delete all documentation sets. | |
| 135 </p><a NAME="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteButton_clicked"></a> | |
| 136 <h4>QtHelpDocumentationSelectionDialog.on_deleteButton_clicked</h4> | |
| 137 <b>on_deleteButton_clicked</b>(<i></i>) | |
| 138 <p> | |
| 139 Private slot to delete the selected documentation sets. | |
| 140 </p><a NAME="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked" ID="QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked"></a> | |
| 141 <h4>QtHelpDocumentationSelectionDialog.on_deleteCategoryButton_clicked</h4> | |
| 142 <b>on_deleteCategoryButton_clicked</b>(<i></i>) | |
| 143 <p> | |
| 144 Private slot to delete the selected documentation set categories. | |
| 145 </p><a NAME="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged" ID="QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged"></a> | |
| 146 <h4>QtHelpDocumentationSelectionDialog.on_documentationList_itemSelectionChanged</h4> | |
| 147 <b>on_documentationList_itemSelectionChanged</b>(<i></i>) | |
| 148 <p> | |
| 149 Private slot handling the selection of items. | |
| 150 </p> | |
| 151 <div align="right"><a href="#top">Up</a></div> | |
| 152 <hr /> | |
| 153 </body></html> |
