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