Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.HelpTocWidget.html
Documentation/Source/eric5.Helpviewer.HelpTocWidget.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.HelpTocWidget</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.HelpTocWidget</h1> | |
| 12 <p> | |
| 13 Module implementing a window for showing the QtHelp TOC. | |
| 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="#HelpTocWidget">HelpTocWidget</a></td> | |
| 23 <td>Class implementing a window for showing the QtHelp TOC.</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="HelpTocWidget" ID="HelpTocWidget"></a> | |
| 32 <h2>HelpTocWidget</h2> | |
| 33 <p> | |
| 34 Class implementing a window for showing the QtHelp TOC. | |
| 35 </p><h4>Signals</h4> | |
| 36 <dl> | |
| 37 <dt>escapePressed()</dt> | |
| 38 <dd> | |
| 39 emitted when the ESC key was pressed | |
| 40 </dd><dt>linkActivated(const QUrl&)</dt> | |
| 41 <dd> | |
| 42 emitted when a TOC entry is activated | |
| 43 </dd> | |
| 44 </dl> | |
| 45 <h3>Derived from</h3> | |
| 46 QWidget | |
| 47 <h3>Class Attributes</h3> | |
| 48 <table> | |
| 49 <tr><td>None</td></tr> | |
| 50 </table> | |
| 51 <h3>Methods</h3> | |
| 52 <table> | |
| 53 <tr> | |
| 54 <td><a href="#HelpTocWidget.__init__">HelpTocWidget</a></td> | |
| 55 <td>Constructor</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#HelpTocWidget.__expandTOC">__expandTOC</a></td> | |
| 58 <td>Private slot to expand the table of contents.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#HelpTocWidget.__showContextMenu">__showContextMenu</a></td> | |
| 61 <td>Private slot showing the context menu.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#HelpTocWidget.eventFilter">eventFilter</a></td> | |
| 64 <td>Public method called to filter the event queue.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#HelpTocWidget.expandToDepth">expandToDepth</a></td> | |
| 67 <td>Public slot to expand the table of contents to a specific depth.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#HelpTocWidget.focusInEvent">focusInEvent</a></td> | |
| 70 <td>Protected method handling focus in events.</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#HelpTocWidget.itemClicked">itemClicked</a></td> | |
| 73 <td>Public slot handling a click of a TOC entry.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#HelpTocWidget.keyPressEvent">keyPressEvent</a></td> | |
| 76 <td>Protected method handling key press events.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td> | |
| 79 <td>Public method to sync the TOC to the displayed page.</td> | |
| 80 </tr> | |
| 81 </table> | |
| 82 <a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a> | |
| 83 <h4>HelpTocWidget (Constructor)</h4> | |
| 84 <b>HelpTocWidget</b>(<i>engine, mainWindow, parent = None</i>) | |
| 85 <p> | |
| 86 Constructor | |
| 87 </p><dl> | |
| 88 <dt><i>engine</i></dt> | |
| 89 <dd> | |
| 90 reference to the help engine (QHelpEngine) | |
| 91 </dd><dt><i>mainWindow</i></dt> | |
| 92 <dd> | |
| 93 reference to the main window object (QMainWindow) | |
| 94 </dd><dt><i>parent</i></dt> | |
| 95 <dd> | |
| 96 reference to the parent widget (QWidget) | |
| 97 </dd> | |
| 98 </dl><a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a> | |
| 99 <h4>HelpTocWidget.__expandTOC</h4> | |
| 100 <b>__expandTOC</b>(<i></i>) | |
| 101 <p> | |
| 102 Private slot to expand the table of contents. | |
| 103 </p><a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a> | |
| 104 <h4>HelpTocWidget.__showContextMenu</h4> | |
| 105 <b>__showContextMenu</b>(<i>pos</i>) | |
| 106 <p> | |
| 107 Private slot showing the context menu. | |
| 108 </p><dl> | |
| 109 <dt><i>pos</i></dt> | |
| 110 <dd> | |
| 111 position to show the menu at (QPoint) | |
| 112 </dd> | |
| 113 </dl><a NAME="HelpTocWidget.eventFilter" ID="HelpTocWidget.eventFilter"></a> | |
| 114 <h4>HelpTocWidget.eventFilter</h4> | |
| 115 <b>eventFilter</b>(<i>watched, event</i>) | |
| 116 <p> | |
| 117 Public method called to filter the event queue. | |
| 118 </p><dl> | |
| 119 <dt><i>watched</i></dt> | |
| 120 <dd> | |
| 121 the QObject being watched (QObject) | |
| 122 </dd><dt><i>event</i></dt> | |
| 123 <dd> | |
| 124 the event that occurred (QEvent) | |
| 125 </dd> | |
| 126 </dl><dl> | |
| 127 <dt>Returns:</dt> | |
| 128 <dd> | |
| 129 flag indicating whether the event was handled (boolean) | |
| 130 </dd> | |
| 131 </dl><a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a> | |
| 132 <h4>HelpTocWidget.expandToDepth</h4> | |
| 133 <b>expandToDepth</b>(<i>depth</i>) | |
| 134 <p> | |
| 135 Public slot to expand the table of contents to a specific depth. | |
| 136 </p><dl> | |
| 137 <dt><i>depth</i></dt> | |
| 138 <dd> | |
| 139 depth to expand to (integer) | |
| 140 </dd> | |
| 141 </dl><a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a> | |
| 142 <h4>HelpTocWidget.focusInEvent</h4> | |
| 143 <b>focusInEvent</b>(<i>evt</i>) | |
| 144 <p> | |
| 145 Protected method handling focus in events. | |
| 146 </p><dl> | |
| 147 <dt><i>evt</i></dt> | |
| 148 <dd> | |
| 149 reference to the focus event object (QFocusEvent) | |
| 150 </dd> | |
| 151 </dl><a NAME="HelpTocWidget.itemClicked" ID="HelpTocWidget.itemClicked"></a> | |
| 152 <h4>HelpTocWidget.itemClicked</h4> | |
| 153 <b>itemClicked</b>(<i>index</i>) | |
| 154 <p> | |
| 155 Public slot handling a click of a TOC entry. | |
| 156 </p><dl> | |
| 157 <dt><i>index</i></dt> | |
| 158 <dd> | |
| 159 index of the TOC clicked (QModelIndex) | |
| 160 </dd> | |
| 161 </dl><a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a> | |
| 162 <h4>HelpTocWidget.keyPressEvent</h4> | |
| 163 <b>keyPressEvent</b>(<i>evt</i>) | |
| 164 <p> | |
| 165 Protected method handling key press events. | |
| 166 </p><dl> | |
| 167 <dt><i>evt</i></dt> | |
| 168 <dd> | |
| 169 reference to the key press event (QKeyEvent) | |
| 170 </dd> | |
| 171 </dl><a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a> | |
| 172 <h4>HelpTocWidget.syncToContent</h4> | |
| 173 <b>syncToContent</b>(<i>url</i>) | |
| 174 <p> | |
| 175 Public method to sync the TOC to the displayed page. | |
| 176 </p><dl> | |
| 177 <dt><i>url</i></dt> | |
| 178 <dd> | |
| 179 URL of the displayed page (QUrl) | |
| 180 </dd> | |
| 181 </dl><dl> | |
| 182 <dt>Returns:</dt> | |
| 183 <dd> | |
| 184 flag indicating a successful synchronization (boolean) | |
| 185 </dd> | |
| 186 </dl> | |
| 187 <div align="right"><a href="#top">Up</a></div> | |
| 188 <hr /> | |
| 189 </body></html> |
