Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpSearchWidget.html

src/eric7/Documentation/Source/eric7.QtHelpInterface.HelpSearchWidget.html

branch
eric7
changeset 10479
856476537696
parent 9686
2eee7a645cba
child 10692
9becf9ca115c
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.QtHelpInterface.HelpSearchWidget</h1> 9 <h1>eric7.QtHelpInterface.HelpSearchWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a window for showing the QtHelp index. 11 Module implementing a window for showing the QtHelp index.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#HelpSearchWidget">HelpSearchWidget</a></td> 22 <td><a href="#HelpSearchWidget">HelpSearchWidget</a></td>
25 <td>Class implementing a window for showing the QtHelp index.</td> 23 <td>Class implementing a window for showing the QtHelp index.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="HelpSearchWidget" ID="HelpSearchWidget"></a> 34 <a NAME="HelpSearchWidget" ID="HelpSearchWidget"></a>
36 <h2>HelpSearchWidget</h2> 35 <h2>HelpSearchWidget</h2>
37
38 <p> 36 <p>
39 Class implementing a window for showing the QtHelp index. 37 Class implementing a window for showing the QtHelp index.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>escapePressed()</dt> 43 <dt>escapePressed()</dt>
45 <dd> 44 <dd>
67 </dd> 66 </dd>
68 </dl> 67 </dl>
69 <h3>Derived from</h3> 68 <h3>Derived from</h3>
70 QWidget 69 QWidget
71 <h3>Class Attributes</h3> 70 <h3>Class Attributes</h3>
72 71 <table>
73 <table> 72 <tr><td>None</td></tr>
74 <tr><td>None</td></tr> 73 </table>
75 </table> 74
76 <h3>Class Methods</h3> 75 <h3>Class Methods</h3>
77 76 <table>
78 <table> 77 <tr><td>None</td></tr>
79 <tr><td>None</td></tr> 78 </table>
80 </table> 79
81 <h3>Methods</h3> 80 <h3>Methods</h3>
82 81 <table>
83 <table>
84
85 <tr> 82 <tr>
86 <td><a href="#HelpSearchWidget.__init__">HelpSearchWidget</a></td> 83 <td><a href="#HelpSearchWidget.__init__">HelpSearchWidget</a></td>
87 <td>Constructor</td> 84 <td>Constructor</td>
88 </tr> 85 </tr>
89 <tr> 86 <tr>
109 <tr> 106 <tr>
110 <td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td> 107 <td><a href="#HelpSearchWidget.keyPressEvent">keyPressEvent</a></td>
111 <td>Protected method handling key press events.</td> 108 <td>Protected method handling key press events.</td>
112 </tr> 109 </tr>
113 </table> 110 </table>
111
114 <h3>Static Methods</h3> 112 <h3>Static Methods</h3>
115 113 <table>
116 <table> 114 <tr><td>None</td></tr>
117 <tr><td>None</td></tr> 115 </table>
118 </table> 116
119 117
120 <a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a> 118 <a NAME="HelpSearchWidget.__init__" ID="HelpSearchWidget.__init__"></a>
121 <h4>HelpSearchWidget (Constructor)</h4> 119 <h4>HelpSearchWidget (Constructor)</h4>
122 <b>HelpSearchWidget</b>(<i>engine, internal=False, parent=None</i>) 120 <b>HelpSearchWidget</b>(<i>engine, internal=False, parent=None</i>)
123
124 <p> 121 <p>
125 Constructor 122 Constructor
126 </p> 123 </p>
124
127 <dl> 125 <dl>
128 126
129 <dt><i>engine</i> (QHelpSearchEngine)</dt> 127 <dt><i>engine</i> (QHelpSearchEngine)</dt>
130 <dd> 128 <dd>
131 reference to the help search engine 129 reference to the help search engine
140 </dd> 138 </dd>
141 </dl> 139 </dl>
142 <a NAME="HelpSearchWidget.__linkActivated" ID="HelpSearchWidget.__linkActivated"></a> 140 <a NAME="HelpSearchWidget.__linkActivated" ID="HelpSearchWidget.__linkActivated"></a>
143 <h4>HelpSearchWidget.__linkActivated</h4> 141 <h4>HelpSearchWidget.__linkActivated</h4>
144 <b>__linkActivated</b>(<i>url</i>) 142 <b>__linkActivated</b>(<i>url</i>)
145
146 <p> 143 <p>
147 Private slot handling the activation of an entry. 144 Private slot handling the activation of an entry.
148 </p> 145 </p>
146
149 <dl> 147 <dl>
150 148
151 <dt><i>url</i> (QUrl)</dt> 149 <dt><i>url</i> (QUrl)</dt>
152 <dd> 150 <dd>
153 URL of the activated entry 151 URL of the activated entry
154 </dd> 152 </dd>
155 </dl> 153 </dl>
156 <a NAME="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a> 154 <a NAME="HelpSearchWidget.__search" ID="HelpSearchWidget.__search"></a>
157 <h4>HelpSearchWidget.__search</h4> 155 <h4>HelpSearchWidget.__search</h4>
158 <b>__search</b>(<i></i>) 156 <b>__search</b>(<i></i>)
159
160 <p> 157 <p>
161 Private slot to perform a search of the database. 158 Private slot to perform a search of the database.
162 </p> 159 </p>
160
163 <a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a> 161 <a NAME="HelpSearchWidget.__searchingFinished" ID="HelpSearchWidget.__searchingFinished"></a>
164 <h4>HelpSearchWidget.__searchingFinished</h4> 162 <h4>HelpSearchWidget.__searchingFinished</h4>
165 <b>__searchingFinished</b>(<i>hits</i>) 163 <b>__searchingFinished</b>(<i>hits</i>)
166
167 <p> 164 <p>
168 Private slot to handle the end of the search. 165 Private slot to handle the end of the search.
169 </p> 166 </p>
167
170 <dl> 168 <dl>
171 169
172 <dt><i>hits</i> (int)</dt> 170 <dt><i>hits</i> (int)</dt>
173 <dd> 171 <dd>
174 number of hits (unused) 172 number of hits (unused)
175 </dd> 173 </dd>
176 </dl> 174 </dl>
177 <a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a> 175 <a NAME="HelpSearchWidget.__searchingStarted" ID="HelpSearchWidget.__searchingStarted"></a>
178 <h4>HelpSearchWidget.__searchingStarted</h4> 176 <h4>HelpSearchWidget.__searchingStarted</h4>
179 <b>__searchingStarted</b>(<i></i>) 177 <b>__searchingStarted</b>(<i></i>)
180
181 <p> 178 <p>
182 Private slot to handle the start of a search. 179 Private slot to handle the start of a search.
183 </p> 180 </p>
181
184 <a NAME="HelpSearchWidget.__showContextMenu" ID="HelpSearchWidget.__showContextMenu"></a> 182 <a NAME="HelpSearchWidget.__showContextMenu" ID="HelpSearchWidget.__showContextMenu"></a>
185 <h4>HelpSearchWidget.__showContextMenu</h4> 183 <h4>HelpSearchWidget.__showContextMenu</h4>
186 <b>__showContextMenu</b>(<i>pos</i>) 184 <b>__showContextMenu</b>(<i>pos</i>)
187
188 <p> 185 <p>
189 Private slot to show a context menu. 186 Private slot to show a context menu.
190 </p> 187 </p>
188
191 <dl> 189 <dl>
192 190
193 <dt><i>pos</i> (QPoint)</dt> 191 <dt><i>pos</i> (QPoint)</dt>
194 <dd> 192 <dd>
195 position for the context menu 193 position for the context menu
196 </dd> 194 </dd>
197 </dl> 195 </dl>
198 <a NAME="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a> 196 <a NAME="HelpSearchWidget.keyPressEvent" ID="HelpSearchWidget.keyPressEvent"></a>
199 <h4>HelpSearchWidget.keyPressEvent</h4> 197 <h4>HelpSearchWidget.keyPressEvent</h4>
200 <b>keyPressEvent</b>(<i>evt</i>) 198 <b>keyPressEvent</b>(<i>evt</i>)
201
202 <p> 199 <p>
203 Protected method handling key press events. 200 Protected method handling key press events.
204 </p> 201 </p>
202
205 <dl> 203 <dl>
206 204
207 <dt><i>evt</i> (QKeyEvent)</dt> 205 <dt><i>evt</i> (QKeyEvent)</dt>
208 <dd> 206 <dd>
209 reference to the key press event 207 reference to the key press event

Mercurial Repository: eric

eric ide

mercurial