Mercurial Repositories > eric / file comparison
comparison: eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpSearchWidget.html
eric7/Documentation/Source/eric7.WebBrowser.QtHelp.HelpSearchWidget.html
- branch
- eric7
- changeset 8372
- e0227a7c850e
- child 8596
- d64760b2da50
equal
deleted
inserted
replaced
| 8371:d6062691d424 | 8372:e0227a7c850e |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.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> | |
| 22 <a NAME="top" ID="top"></a> | |
| 23 <h1>eric7.WebBrowser.QtHelp.HelpSearchWidget</h1> | |
| 24 | |
| 25 <p> | |
| 26 Module implementing a window for showing the QtHelp index. | |
| 27 </p> | |
| 28 <h3>Global Attributes</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <h3>Classes</h3> | |
| 34 | |
| 35 <table> | |
| 36 | |
| 37 <tr> | |
| 38 <td><a href="#HelpSearchWidget">HelpSearchWidget</a></td> | |
| 39 <td>Class implementing a window for showing the QtHelp index.</td> | |
| 40 </tr> | |
| 41 </table> | |
| 42 <h3>Functions</h3> | |
| 43 | |
| 44 <table> | |
| 45 <tr><td>None</td></tr> | |
| 46 </table> | |
| 47 <hr /> | |
| 48 <hr /> | |
| 49 <a NAME="HelpSearchWidget" ID="HelpSearchWidget"></a> | |
| 50 <h2>HelpSearchWidget</h2> | |
| 51 | |
| 52 <p> | |
| 53 Class implementing a window for showing the QtHelp index. | |
| 54 </p> | |
| 55 <h3>Signals</h3> | |
| 56 <dl> | |
| 57 | |
| 58 <dt>escapePressed()</dt> | |
| 59 <dd> | |
| 60 emitted when the ESC key was pressed | |
| 61 </dd> | |
| 62 <dt>newBackgroundTab(QUrl, str)</dt> | |
| 63 <dd> | |
| 64 emitted to open a search result entry | |
| 65 in a new background tab | |
| 66 </dd> | |
| 67 <dt>newTab(QUrl, str)</dt> | |
| 68 <dd> | |
| 69 emitted to open a search result entry in a | |
| 70 new tab | |
| 71 </dd> | |
| 72 <dt>newWindow(QUrl, str)</dt> | |
| 73 <dd> | |
| 74 emitted to open a search result entry in a | |
| 75 new window | |
| 76 </dd> | |
| 77 <dt>openUrl(QUrl, str)</dt> | |
| 78 <dd> | |
| 79 emitted to open a search result entry in the | |
| 80 current tab | |
| 81 </dd> | |
| 82 </dl> | |
| 83 <h3>Derived from</h3> | |
| 84 QWidget | |
| 85 <h3>Class Attributes</h3> | |
| 86 | |
| 87 <table> | |
| 88 <tr><td>None</td></tr> | |
| 89 </table> | |
| 90 <h3>Class Methods</h3> | |
| 91 | |
| 92 <table> | |
| 93 <tr><td>None</td></tr> | |
| 94 </table> | |
| 95 <h3>Methods</h3> | |
| 96 | |
| 97 <table> | |
| 98 | |
| 99 <tr> | |
| 100 <td><a href="#HelpSearchWidget.__init__">HelpSearchWidget</a></td> | |
| 101 <td>Constructor</td> | |
| 102 </tr> | |
| 103 <tr> | |
| 104 <td><a href="#HelpSearchWidget.__linkActivated">__linkActivated</a></td> | |
| 105 <td>Private slot handling the activation of an entry.</td> | |
| 106 </tr> | |
| 107 <tr> | |
| 108 <td><a href="#HelpSearchWidget.__search">__search</a></td> | |
| 109 <td>Private slot to perform a search of the database.</td> | |
| 110 </tr> | |
| 111 <tr> | |
| 112 <td><a href="#HelpSearchWidget.__searchingFinished">__searchingFinished</a></td> | |
| 113 <td>Private slot to handle the end of the search.</td> | |
| 114 </tr> | |
| 115 <tr> | |
| 116 <td><a href="#HelpSearchWidget.__searchingStarted">__searchingStarted</a></td> | |
| 117 <td>Private slot to handle the start of a search.</td> | |
| 118 </tr> | |
| 119 <tr> | |
| 120 <td><a href="#HelpSearchWidget.contextMenuEvent">contextMenuEvent</a></td> | |
| 121 <td>Protected method handling context menu events.</td> | |
| 122 </tr> | |
| 123 <tr> | |
| 124 <td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td> | |
| 125 <td>Protected method handling key press events.</td> | |
| 126 </tr> | |
| 127 </table> | |
| 128 <h3>Static Methods</h3> | |
| 129 | |
| 130 <table> | |
| 131 <tr><td>None</td></tr> | |
| 132 </table> | |
| 133 | |
| 134 <a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a> | |
| 135 <h4>HelpSearchWidget (Constructor)</h4> | |
| 136 <b>HelpSearchWidget</b>(<i>engine, parent=None</i>) | |
| 137 | |
| 138 <p> | |
| 139 Constructor | |
| 140 </p> | |
| 141 <dl> | |
| 142 | |
| 143 <dt><i>engine</i></dt> | |
| 144 <dd> | |
| 145 reference to the help search engine (QHelpSearchEngine) | |
| 146 </dd> | |
| 147 <dt><i>parent</i></dt> | |
| 148 <dd> | |
| 149 reference to the parent widget (QWidget) | |
| 150 </dd> | |
| 151 </dl> | |
| 152 <a NAME="HelpSearchWidget.__linkActivated" ID="HelpSearchWidget.__linkActivated"></a> | |
| 153 <h4>HelpSearchWidget.__linkActivated</h4> | |
| 154 <b>__linkActivated</b>(<i>url</i>) | |
| 155 | |
| 156 <p> | |
| 157 Private slot handling the activation of an entry. | |
| 158 </p> | |
| 159 <dl> | |
| 160 | |
| 161 <dt><i>url</i> (QUrl)</dt> | |
| 162 <dd> | |
| 163 URL of the activated entry | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <a NAME="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a> | |
| 167 <h4>HelpSearchWidget.__search</h4> | |
| 168 <b>__search</b>(<i></i>) | |
| 169 | |
| 170 <p> | |
| 171 Private slot to perform a search of the database. | |
| 172 </p> | |
| 173 <a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a> | |
| 174 <h4>HelpSearchWidget.__searchingFinished</h4> | |
| 175 <b>__searchingFinished</b>(<i>hits</i>) | |
| 176 | |
| 177 <p> | |
| 178 Private slot to handle the end of the search. | |
| 179 </p> | |
| 180 <dl> | |
| 181 | |
| 182 <dt><i>hits</i></dt> | |
| 183 <dd> | |
| 184 number of hits (integer) (unused) | |
| 185 </dd> | |
| 186 </dl> | |
| 187 <a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a> | |
| 188 <h4>HelpSearchWidget.__searchingStarted</h4> | |
| 189 <b>__searchingStarted</b>(<i></i>) | |
| 190 | |
| 191 <p> | |
| 192 Private slot to handle the start of a search. | |
| 193 </p> | |
| 194 <a NAME="HelpSearchWidget.contextMenuEvent" ID="HelpSearchWidget.contextMenuEvent"></a> | |
| 195 <h4>HelpSearchWidget.contextMenuEvent</h4> | |
| 196 <b>contextMenuEvent</b>(<i>evt</i>) | |
| 197 | |
| 198 <p> | |
| 199 Protected method handling context menu events. | |
| 200 </p> | |
| 201 <dl> | |
| 202 | |
| 203 <dt><i>evt</i></dt> | |
| 204 <dd> | |
| 205 reference to the context menu event (QContextMenuEvent) | |
| 206 </dd> | |
| 207 </dl> | |
| 208 <a NAME="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a> | |
| 209 <h4>HelpSearchWidget.keyPressEvent</h4> | |
| 210 <b>keyPressEvent</b>(<i>evt</i>) | |
| 211 | |
| 212 <p> | |
| 213 Protected method handling key press events. | |
| 214 </p> | |
| 215 <dl> | |
| 216 | |
| 217 <dt><i>evt</i></dt> | |
| 218 <dd> | |
| 219 reference to the key press event (QKeyEvent) | |
| 220 </dd> | |
| 221 </dl> | |
| 222 <div align="right"><a href="#top">Up</a></div> | |
| 223 <hr /> | |
| 224 </body></html> |
