Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.WebBrowser.QtHelp.HelpSearchWidget.html
Documentation/Source/eric6.WebBrowser.QtHelp.HelpSearchWidget.html
- changeset 4918
- 71caf42a13d8
- child 5038
- df7103c3f2a6
equal
deleted
inserted
replaced
| 4917:682750cc7bd5 | 4918:71caf42a13d8 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.WebBrowser.QtHelp.HelpSearchWidget</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.HelpSearchWidget</h1> | |
| 23 <p> | |
| 24 Module implementing a window for showing the QtHelp index. | |
| 25 </p> | |
| 26 <h3>Global Attributes</h3> | |
| 27 <table> | |
| 28 <tr><td>None</td></tr> | |
| 29 </table> | |
| 30 <h3>Classes</h3> | |
| 31 <table> | |
| 32 <tr> | |
| 33 <td><a href="#HelpSearchWidget">HelpSearchWidget</a></td> | |
| 34 <td>Class implementing a window for showing the QtHelp index.</td> | |
| 35 </tr> | |
| 36 </table> | |
| 37 <h3>Functions</h3> | |
| 38 <table> | |
| 39 <tr><td>None</td></tr> | |
| 40 </table> | |
| 41 <hr /><hr /> | |
| 42 <a NAME="HelpSearchWidget" ID="HelpSearchWidget"></a> | |
| 43 <h2>HelpSearchWidget</h2> | |
| 44 <p> | |
| 45 Class implementing a window for showing the QtHelp index. | |
| 46 </p><h3>Signals</h3> | |
| 47 <dl> | |
| 48 <dt>escapePressed()</dt> | |
| 49 <dd> | |
| 50 emitted when the ESC key was pressed | |
| 51 </dd><dt>linkActivated(QUrl)</dt> | |
| 52 <dd> | |
| 53 emitted when a search result entry is activated | |
| 54 </dd> | |
| 55 </dl> | |
| 56 <h3>Derived from</h3> | |
| 57 QWidget | |
| 58 <h3>Class Attributes</h3> | |
| 59 <table> | |
| 60 <tr><td>None</td></tr> | |
| 61 </table> | |
| 62 <h3>Class Methods</h3> | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Methods</h3> | |
| 67 <table> | |
| 68 <tr> | |
| 69 <td><a href="#HelpSearchWidget.__init__">HelpSearchWidget</a></td> | |
| 70 <td>Constructor</td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#HelpSearchWidget.__search">__search</a></td> | |
| 73 <td>Private slot to perform a search of the database.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#HelpSearchWidget.__searchingFinished">__searchingFinished</a></td> | |
| 76 <td>Private slot to handle the end of the search.</td> | |
| 77 </tr><tr> | |
| 78 <td><a href="#HelpSearchWidget.__searchingStarted">__searchingStarted</a></td> | |
| 79 <td>Private slot to handle the start of a search.</td> | |
| 80 </tr><tr> | |
| 81 <td><a href="#HelpSearchWidget.contextMenuEvent">contextMenuEvent</a></td> | |
| 82 <td>Protected method handling context menu events.</td> | |
| 83 </tr><tr> | |
| 84 <td><a href="#HelpSearchWidget.eventFilter">eventFilter</a></td> | |
| 85 <td>Public method called to filter the event queue.</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td> | |
| 88 <td>Protected method handling key press events.</td> | |
| 89 </tr> | |
| 90 </table> | |
| 91 <h3>Static Methods</h3> | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 <a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a> | |
| 96 <h4>HelpSearchWidget (Constructor)</h4> | |
| 97 <b>HelpSearchWidget</b>(<i>engine, mainWindow, parent=None</i>) | |
| 98 <p> | |
| 99 Constructor | |
| 100 </p><dl> | |
| 101 <dt><i>engine</i></dt> | |
| 102 <dd> | |
| 103 reference to the help search engine (QHelpSearchEngine) | |
| 104 </dd><dt><i>mainWindow</i></dt> | |
| 105 <dd> | |
| 106 reference to the main window object (QMainWindow) | |
| 107 </dd><dt><i>parent</i></dt> | |
| 108 <dd> | |
| 109 reference to the parent widget (QWidget) | |
| 110 </dd> | |
| 111 </dl><a NAME="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a> | |
| 112 <h4>HelpSearchWidget.__search</h4> | |
| 113 <b>__search</b>(<i></i>) | |
| 114 <p> | |
| 115 Private slot to perform a search of the database. | |
| 116 </p><a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a> | |
| 117 <h4>HelpSearchWidget.__searchingFinished</h4> | |
| 118 <b>__searchingFinished</b>(<i>hits</i>) | |
| 119 <p> | |
| 120 Private slot to handle the end of the search. | |
| 121 </p><dl> | |
| 122 <dt><i>hits</i></dt> | |
| 123 <dd> | |
| 124 number of hits (integer) (unused) | |
| 125 </dd> | |
| 126 </dl><a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a> | |
| 127 <h4>HelpSearchWidget.__searchingStarted</h4> | |
| 128 <b>__searchingStarted</b>(<i></i>) | |
| 129 <p> | |
| 130 Private slot to handle the start of a search. | |
| 131 </p><a NAME="HelpSearchWidget.contextMenuEvent" ID="HelpSearchWidget.contextMenuEvent"></a> | |
| 132 <h4>HelpSearchWidget.contextMenuEvent</h4> | |
| 133 <b>contextMenuEvent</b>(<i>evt</i>) | |
| 134 <p> | |
| 135 Protected method handling context menu events. | |
| 136 </p><dl> | |
| 137 <dt><i>evt</i></dt> | |
| 138 <dd> | |
| 139 reference to the context menu event (QContextMenuEvent) | |
| 140 </dd> | |
| 141 </dl><a NAME="HelpSearchWidget.eventFilter" ID="HelpSearchWidget.eventFilter"></a> | |
| 142 <h4>HelpSearchWidget.eventFilter</h4> | |
| 143 <b>eventFilter</b>(<i>watched, event</i>) | |
| 144 <p> | |
| 145 Public method called to filter the event queue. | |
| 146 </p><dl> | |
| 147 <dt><i>watched</i></dt> | |
| 148 <dd> | |
| 149 the QObject being watched (QObject) | |
| 150 </dd><dt><i>event</i></dt> | |
| 151 <dd> | |
| 152 the event that occurred (QEvent) | |
| 153 </dd> | |
| 154 </dl><dl> | |
| 155 <dt>Returns:</dt> | |
| 156 <dd> | |
| 157 flag indicating whether the event was handled (boolean) | |
| 158 </dd> | |
| 159 </dl><a NAME="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a> | |
| 160 <h4>HelpSearchWidget.keyPressEvent</h4> | |
| 161 <b>keyPressEvent</b>(<i>evt</i>) | |
| 162 <p> | |
| 163 Protected method handling key press events. | |
| 164 </p><dl> | |
| 165 <dt><i>evt</i></dt> | |
| 166 <dd> | |
| 167 reference to the key press event (QKeyEvent) | |
| 168 </dd> | |
| 169 </dl> | |
| 170 <div align="right"><a href="#top">Up</a></div> | |
| 171 <hr /> | |
| 172 </body></html> |
