Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.HelpIndexWidget.html
Documentation/Source/eric5.Helpviewer.HelpIndexWidget.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.HelpIndexWidget</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.HelpIndexWidget</h1> | |
| 12 <p> | |
| 13 Module implementing a window for showing the QtHelp index. | |
| 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="#HelpIndexWidget">HelpIndexWidget</a></td> | |
| 23 <td>Class implementing a window for showing the QtHelp index.</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="HelpIndexWidget" ID="HelpIndexWidget"></a> | |
| 32 <h2>HelpIndexWidget</h2> | |
| 33 <p> | |
| 34 Class implementing a window for showing the QtHelp index. | |
| 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 an index 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="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> | |
| 55 <td>Constructor</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> | |
| 58 <td>Private slot to enable the search edit.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td> | |
| 61 <td>Private slot to enable the search edit.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> | |
| 64 <td>Private slot to filter the indices according to the given filter.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> | |
| 67 <td>Public method called to filter the event queue.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> | |
| 70 <td>Protected method handling focus in events.</td> | |
| 71 </tr> | |
| 72 </table> | |
| 73 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a> | |
| 74 <h4>HelpIndexWidget (Constructor)</h4> | |
| 75 <b>HelpIndexWidget</b>(<i>engine, mainWindow, parent = None</i>) | |
| 76 <p> | |
| 77 Constructor | |
| 78 </p><dl> | |
| 79 <dt><i>engine</i></dt> | |
| 80 <dd> | |
| 81 reference to the help engine (QHelpEngine) | |
| 82 </dd><dt><i>mainWindow</i></dt> | |
| 83 <dd> | |
| 84 reference to the main window object (QMainWindow) | |
| 85 </dd><dt><i>parent</i></dt> | |
| 86 <dd> | |
| 87 reference to the parent widget (QWidget) | |
| 88 </dd> | |
| 89 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> | |
| 90 <h4>HelpIndexWidget.__disableSearchEdit</h4> | |
| 91 <b>__disableSearchEdit</b>(<i></i>) | |
| 92 <p> | |
| 93 Private slot to enable the search edit. | |
| 94 </p><a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a> | |
| 95 <h4>HelpIndexWidget.__enableSearchEdit</h4> | |
| 96 <b>__enableSearchEdit</b>(<i></i>) | |
| 97 <p> | |
| 98 Private slot to enable the search edit. | |
| 99 </p><a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a> | |
| 100 <h4>HelpIndexWidget.__filterIndices</h4> | |
| 101 <b>__filterIndices</b>(<i>filter</i>) | |
| 102 <p> | |
| 103 Private slot to filter the indices according to the given filter. | |
| 104 </p><dl> | |
| 105 <dt><i>filter</i></dt> | |
| 106 <dd> | |
| 107 filter to be used (string) | |
| 108 </dd> | |
| 109 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> | |
| 110 <h4>HelpIndexWidget.eventFilter</h4> | |
| 111 <b>eventFilter</b>(<i>watched, event</i>) | |
| 112 <p> | |
| 113 Public method called to filter the event queue. | |
| 114 </p><dl> | |
| 115 <dt><i>watched</i></dt> | |
| 116 <dd> | |
| 117 the QObject being watched (QObject) | |
| 118 </dd><dt><i>event</i></dt> | |
| 119 <dd> | |
| 120 the event that occurred (QEvent) | |
| 121 </dd> | |
| 122 </dl><dl> | |
| 123 <dt>Returns:</dt> | |
| 124 <dd> | |
| 125 flag indicating whether the event was handled (boolean) | |
| 126 </dd> | |
| 127 </dl><a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a> | |
| 128 <h4>HelpIndexWidget.focusInEvent</h4> | |
| 129 <b>focusInEvent</b>(<i>evt</i>) | |
| 130 <p> | |
| 131 Protected method handling focus in events. | |
| 132 </p><dl> | |
| 133 <dt><i>evt</i></dt> | |
| 134 <dd> | |
| 135 reference to the focus event object (QFocusEvent) | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <div align="right"><a href="#top">Up</a></div> | |
| 139 <hr /> | |
| 140 </body></html> |
