Mercurial Repositories > eric / file comparison
comparison: eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpSearchWidget.html
eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpSearchWidget.html
- changeset 6942
- 2602857055c5
- parent 5252
- 321c2003745d
- child 7273
- 391d6b7b1eff
equal
deleted
inserted
replaced
| 6941:f99d60d6b59b | 6942:2602857055c5 |
|---|---|
| 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>newBackgroundTab(QUrl, str)</dt> | |
| 52 <dd> | |
| 53 emitted to open a search result entry | |
| 54 in a new background tab | |
| 55 </dd><dt>newTab(QUrl, str)</dt> | |
| 56 <dd> | |
| 57 emitted to open a search result entry in a | |
| 58 new tab | |
| 59 </dd><dt>newWindow(QUrl, str)</dt> | |
| 60 <dd> | |
| 61 emitted to open a search result entry in a | |
| 62 new window | |
| 63 </dd><dt>openUrl(QUrl, str)</dt> | |
| 64 <dd> | |
| 65 emitted to open a search result entry in the | |
| 66 current tab | |
| 67 </dd> | |
| 68 </dl> | |
| 69 <h3>Derived from</h3> | |
| 70 QWidget | |
| 71 <h3>Class Attributes</h3> | |
| 72 <table> | |
| 73 <tr><td>None</td></tr> | |
| 74 </table> | |
| 75 <h3>Class Methods</h3> | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 <h3>Methods</h3> | |
| 80 <table> | |
| 81 <tr> | |
| 82 <td><a href="#HelpSearchWidget.__init__">HelpSearchWidget</a></td> | |
| 83 <td>Constructor</td> | |
| 84 </tr><tr> | |
| 85 <td><a href="#HelpSearchWidget.__linkActivated">__linkActivated</a></td> | |
| 86 <td>Private slot handling the activation of an entry.</td> | |
| 87 </tr><tr> | |
| 88 <td><a href="#HelpSearchWidget.__search">__search</a></td> | |
| 89 <td>Private slot to perform a search of the database.</td> | |
| 90 </tr><tr> | |
| 91 <td><a href="#HelpSearchWidget.__searchingFinished">__searchingFinished</a></td> | |
| 92 <td>Private slot to handle the end of the search.</td> | |
| 93 </tr><tr> | |
| 94 <td><a href="#HelpSearchWidget.__searchingStarted">__searchingStarted</a></td> | |
| 95 <td>Private slot to handle the start of a search.</td> | |
| 96 </tr><tr> | |
| 97 <td><a href="#HelpSearchWidget.contextMenuEvent">contextMenuEvent</a></td> | |
| 98 <td>Protected method handling context menu events.</td> | |
| 99 </tr><tr> | |
| 100 <td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td> | |
| 101 <td>Protected method handling key press events.</td> | |
| 102 </tr> | |
| 103 </table> | |
| 104 <h3>Static Methods</h3> | |
| 105 <table> | |
| 106 <tr><td>None</td></tr> | |
| 107 </table> | |
| 108 <a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a> | |
| 109 <h4>HelpSearchWidget (Constructor)</h4> | |
| 110 <b>HelpSearchWidget</b>(<i>engine, parent=None</i>) | |
| 111 <p> | |
| 112 Constructor | |
| 113 </p><dl> | |
| 114 <dt><i>engine</i></dt> | |
| 115 <dd> | |
| 116 reference to the help search engine (QHelpSearchEngine) | |
| 117 </dd><dt><i>parent</i></dt> | |
| 118 <dd> | |
| 119 reference to the parent widget (QWidget) | |
| 120 </dd> | |
| 121 </dl><a NAME="HelpSearchWidget.__linkActivated" ID="HelpSearchWidget.__linkActivated"></a> | |
| 122 <h4>HelpSearchWidget.__linkActivated</h4> | |
| 123 <b>__linkActivated</b>(<i>url</i>) | |
| 124 <p> | |
| 125 Private slot handling the activation of an entry. | |
| 126 </p><dl> | |
| 127 <dt><i>url</i> (QUrl)</dt> | |
| 128 <dd> | |
| 129 URL of the activated entry | |
| 130 </dd> | |
| 131 </dl><a NAME="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a> | |
| 132 <h4>HelpSearchWidget.__search</h4> | |
| 133 <b>__search</b>(<i></i>) | |
| 134 <p> | |
| 135 Private slot to perform a search of the database. | |
| 136 </p><a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a> | |
| 137 <h4>HelpSearchWidget.__searchingFinished</h4> | |
| 138 <b>__searchingFinished</b>(<i>hits</i>) | |
| 139 <p> | |
| 140 Private slot to handle the end of the search. | |
| 141 </p><dl> | |
| 142 <dt><i>hits</i></dt> | |
| 143 <dd> | |
| 144 number of hits (integer) (unused) | |
| 145 </dd> | |
| 146 </dl><a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a> | |
| 147 <h4>HelpSearchWidget.__searchingStarted</h4> | |
| 148 <b>__searchingStarted</b>(<i></i>) | |
| 149 <p> | |
| 150 Private slot to handle the start of a search. | |
| 151 </p><a NAME="HelpSearchWidget.contextMenuEvent" ID="HelpSearchWidget.contextMenuEvent"></a> | |
| 152 <h4>HelpSearchWidget.contextMenuEvent</h4> | |
| 153 <b>contextMenuEvent</b>(<i>evt</i>) | |
| 154 <p> | |
| 155 Protected method handling context menu events. | |
| 156 </p><dl> | |
| 157 <dt><i>evt</i></dt> | |
| 158 <dd> | |
| 159 reference to the context menu event (QContextMenuEvent) | |
| 160 </dd> | |
| 161 </dl><a NAME="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a> | |
| 162 <h4>HelpSearchWidget.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> | |
| 172 <div align="right"><a href="#top">Up</a></div> | |
| 173 <hr /> | |
| 174 </body></html> |
