Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric4.Helpviewer.QtHelpDocumentationDialog.html
Documentation/Source/eric4.Helpviewer.QtHelpDocumentationDialog.html
- changeset 3
- 0d9daebf5b8c
equal
deleted
inserted
replaced
| 2:bc6196164237 | 3:0d9daebf5b8c |
|---|---|
| 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>eric4.Helpviewer.QtHelpDocumentationDialog</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background:white; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #4FA4FF; } | |
| 14 h2 { color: white; background: #4FA4FF; } | |
| 15 h3 { color: white; background: #00557F; } | |
| 16 h4 { color: white; background: #00557F; } | |
| 17 | |
| 18 a { color: #AA5500; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric4.Helpviewer.QtHelpDocumentationDialog</h1> | |
| 24 <p> | |
| 25 Module implementing a dialog to manage the QtHelp documentation database. | |
| 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="#QtHelpDocumentationDialog">QtHelpDocumentationDialog</a></td> | |
| 35 <td>Class implementing a dialog to manage the QtHelp documentation database.</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="QtHelpDocumentationDialog" ID="QtHelpDocumentationDialog"></a> | |
| 44 <h2>QtHelpDocumentationDialog</h2> | |
| 45 <p> | |
| 46 Class implementing a dialog to manage the QtHelp documentation database. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QDialog, Ui_QtHelpDocumentationDialog | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <tr><td>None</td></tr> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#QtHelpDocumentationDialog.__init__">QtHelpDocumentationDialog</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#QtHelpDocumentationDialog.getTabsToClose">getTabsToClose</a></td> | |
| 61 <td>Public method to get the list of tabs to close.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#QtHelpDocumentationDialog.hasChanges">hasChanges</a></td> | |
| 64 <td>Public slot to test the dialog for changes.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#QtHelpDocumentationDialog.on_addButton_clicked">on_addButton_clicked</a></td> | |
| 67 <td>Private slot to add documents to the help database.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged">on_documentsList_itemSelectionChanged</a></td> | |
| 70 <td>Private slot handling a change of the documents selection.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#QtHelpDocumentationDialog.on_removeButton_clicked">on_removeButton_clicked</a></td> | |
| 73 <td>Private slot to remove a document from the help database.</td> | |
| 74 </tr> | |
| 75 </table> | |
| 76 <a NAME="QtHelpDocumentationDialog.__init__" ID="QtHelpDocumentationDialog.__init__"></a> | |
| 77 <h4>QtHelpDocumentationDialog (Constructor)</h4> | |
| 78 <b>QtHelpDocumentationDialog</b>(<i>engine, parent</i>) | |
| 79 <p> | |
| 80 Constructor | |
| 81 </p><dl> | |
| 82 <dt><i>engine</i></dt> | |
| 83 <dd> | |
| 84 reference to the help engine (QHelpEngine) | |
| 85 </dd><dt><i>parent</i></dt> | |
| 86 <dd> | |
| 87 reference to the parent widget (QWidget) | |
| 88 </dd> | |
| 89 </dl><a NAME="QtHelpDocumentationDialog.getTabsToClose" ID="QtHelpDocumentationDialog.getTabsToClose"></a> | |
| 90 <h4>QtHelpDocumentationDialog.getTabsToClose</h4> | |
| 91 <b>getTabsToClose</b>(<i></i>) | |
| 92 <p> | |
| 93 Public method to get the list of tabs to close. | |
| 94 </p><dl> | |
| 95 <dt>Returns:</dt> | |
| 96 <dd> | |
| 97 list of tab ids to be closed (list of integers) | |
| 98 </dd> | |
| 99 </dl><a NAME="QtHelpDocumentationDialog.hasChanges" ID="QtHelpDocumentationDialog.hasChanges"></a> | |
| 100 <h4>QtHelpDocumentationDialog.hasChanges</h4> | |
| 101 <b>hasChanges</b>(<i></i>) | |
| 102 <p> | |
| 103 Public slot to test the dialog for changes. | |
| 104 </p><dl> | |
| 105 <dt>Returns:</dt> | |
| 106 <dd> | |
| 107 flag indicating presence of changes | |
| 108 </dd> | |
| 109 </dl><a NAME="QtHelpDocumentationDialog.on_addButton_clicked" ID="QtHelpDocumentationDialog.on_addButton_clicked"></a> | |
| 110 <h4>QtHelpDocumentationDialog.on_addButton_clicked</h4> | |
| 111 <b>on_addButton_clicked</b>(<i></i>) | |
| 112 <p> | |
| 113 Private slot to add documents to the help database. | |
| 114 </p><a NAME="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged" ID="QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged"></a> | |
| 115 <h4>QtHelpDocumentationDialog.on_documentsList_itemSelectionChanged</h4> | |
| 116 <b>on_documentsList_itemSelectionChanged</b>(<i></i>) | |
| 117 <p> | |
| 118 Private slot handling a change of the documents selection. | |
| 119 </p><a NAME="QtHelpDocumentationDialog.on_removeButton_clicked" ID="QtHelpDocumentationDialog.on_removeButton_clicked"></a> | |
| 120 <h4>QtHelpDocumentationDialog.on_removeButton_clicked</h4> | |
| 121 <b>on_removeButton_clicked</b>(<i></i>) | |
| 122 <p> | |
| 123 Private slot to remove a document from the help database. | |
| 124 </p> | |
| 125 <div align="right"><a href="#top">Up</a></div> | |
| 126 <hr /> | |
| 127 </body></html> |
