Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.QtHelpDocumentationDialog.html
Documentation/Source/eric5.Helpviewer.QtHelpDocumentationDialog.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.QtHelpDocumentationDialog</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.Helpviewer.QtHelpDocumentationDialog</h1> | |
| 12 <p> | |
| 13 Module implementing a dialog to manage the QtHelp documentation database. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#QtHelpDocumentationDialog">QtHelpDocumentationDialog</a></td> | |
| 23 <td>Class implementing a dialog to manage the QtHelp documentation database.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <hr /><hr /> | |
| 31 <a NAME="QtHelpDocumentationDialog" ID="QtHelpDocumentationDialog"></a> | |
| 32 <h2>QtHelpDocumentationDialog</h2> | |
| 33 <p> | |
| 34 Class implementing a dialog to manage the QtHelp documentation database. | |
| 35 </p> | |
| 36 <h3>Derived from</h3> | |
| 37 QDialog, Ui_QtHelpDocumentationDialog | |
| 38 <h3>Class Attributes</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <h3>Methods</h3> | |
| 43 <table> | |
| 44 <tr> | |
| 45 <td><a href="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td> | |
| 46 <td>Constructor</td> | |
| 47 </tr><tr> | |
| 48 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td> | |
| 49 <td>Public method to get the list of tabs to close.</td> | |
| 50 </tr><tr> | |
| 51 <td><a href="#QtHelpDocumentationDialog.hasChanges">hasChanges</a></td> | |
| 52 <td>Public slot to test the dialog for changes.</td> | |
| 53 </tr><tr> | |
| 54 <td><a href="#QtHelpDocumentationDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 55 <td>Private slot to add documents to the help database.</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td> | |
| 58 <td>Private slot handling a change of the documents selection.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#QtHelpDocumentationDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> | |
| 61 <td>Private slot to remove a document from the help database.</td> | |
| 62 </tr> | |
| 63 </table> | |
| 64 <a NAME="QtHelpDocumentationDialog.__init__" ID="QtHelpDocumentationDialog.__init__"></a> | |
| 65 <h4>QtHelpDocumentationDialog (Constructor)</h4> | |
| 66 <b>QtHelpDocumentationDialog</b>(<i>engine, parent</i>) | |
| 67 <p> | |
| 68 Constructor | |
| 69 </p><dl> | |
| 70 <dt><i>engine</i></dt> | |
| 71 <dd> | |
| 72 reference to the help engine (QHelpEngine) | |
| 73 </dd><dt><i>parent</i></dt> | |
| 74 <dd> | |
| 75 reference to the parent widget (QWidget) | |
| 76 </dd> | |
| 77 </dl><a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a> | |
| 78 <h4>QtHelpDocumentationDialog.getTabsToClose</h4> | |
| 79 <b>getTabsToClose</b>(<i></i>) | |
| 80 <p> | |
| 81 Public method to get the list of tabs to close. | |
| 82 </p><dl> | |
| 83 <dt>Returns:</dt> | |
| 84 <dd> | |
| 85 list of tab ids to be closed (list of integers) | |
| 86 </dd> | |
| 87 </dl><a NAME="QtHelpDocumentationDialog.hasChanges" ID="QtHelpDocumentationDialog.hasChanges"></a> | |
| 88 <h4>QtHelpDocumentationDialog.hasChanges</h4> | |
| 89 <b>hasChanges</b>(<i></i>) | |
| 90 <p> | |
| 91 Public slot to test the dialog for changes. | |
| 92 </p><dl> | |
| 93 <dt>Returns:</dt> | |
| 94 <dd> | |
| 95 flag indicating presence of changes | |
| 96 </dd> | |
| 97 </dl><a NAME="QtHelpDocumentationDialog.on_addButton_clicked" ID="QtHelpDocumentationDialog.on_addButton_clicked"></a> | |
| 98 <h4>QtHelpDocumentationDialog.on_addButton_clicked</h4> | |
| 99 <b>on_addButton_clicked</b>(<i></i>) | |
| 100 <p> | |
| 101 Private slot to add documents to the help database. | |
| 102 </p><a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a> | |
| 103 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4> | |
| 104 <b>on_documentsList_itemSelectionChanged</b>(<i></i>) | |
| 105 <p> | |
| 106 Private slot handling a change of the documents selection. | |
| 107 </p><a NAME="QtHelpDocumentationDialog.on_removeButton_clicked" ID="QtHelpDocumentationDialog.on_removeButton_clicked"></a> | |
| 108 <h4>QtHelpDocumentationDialog.on_removeButton_clicked</h4> | |
| 109 <b>on_removeButton_clicked</b>(<i></i>) | |
| 110 <p> | |
| 111 Private slot to remove a document from the help database. | |
| 112 </p> | |
| 113 <div align="right"><a href="#top">Up</a></div> | |
| 114 <hr /> | |
| 115 </body></html> |
