71 <table> |
71 <table> |
72 <tr> |
72 <tr> |
73 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> |
73 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td> |
74 <td>Constructor</td> |
74 <td>Constructor</td> |
75 </tr><tr> |
75 </tr><tr> |
76 <td><a href="#HelpIndexWidget.__activated">__activated</a></td> |
|
77 <td>Private slot to handle the activation of a keyword entry.</td> |
|
78 </tr><tr> |
|
79 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> |
76 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td> |
80 <td>Private slot to enable the search edit.</td> |
77 <td>Private slot to enable the search edit.</td> |
81 </tr><tr> |
78 </tr><tr> |
82 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td> |
79 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td> |
83 <td>Private slot to enable the search edit.</td> |
80 <td>Private slot to enable the search edit.</td> |
84 </tr><tr> |
81 </tr><tr> |
85 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> |
82 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td> |
86 <td>Private slot to filter the indices according to the given filter.</td> |
83 <td>Private slot to filter the indices according to the given filter.</td> |
|
84 </tr><tr> |
|
85 <td><a href="#HelpIndexWidget.__linkActivated">__linkActivated</a></td> |
|
86 <td>Private slot to handle the activation of a keyword entry.</td> |
|
87 </tr><tr> |
|
88 <td><a href="#HelpIndexWidget.__linksActivated">__linksActivated</a></td> |
|
89 <td>Private slot to handle the activation of an entry with multiple links.</td> |
|
90 </tr><tr> |
|
91 <td><a href="#HelpIndexWidget.__selectLink">__selectLink</a></td> |
|
92 <td>Private method to give the user a chance to select among the returned links.</td> |
|
93 </tr><tr> |
|
94 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td> |
|
95 <td>Private slot showing the context menu.</td> |
87 </tr><tr> |
96 </tr><tr> |
88 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> |
97 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td> |
89 <td>Public method called to filter the event queue.</td> |
98 <td>Public method called to filter the event queue.</td> |
90 </tr><tr> |
99 </tr><tr> |
91 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> |
100 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td> |
109 <dd> |
118 <dd> |
110 reference to the main window object (QMainWindow) |
119 reference to the main window object (QMainWindow) |
111 </dd><dt><i>parent</i></dt> |
120 </dd><dt><i>parent</i></dt> |
112 <dd> |
121 <dd> |
113 reference to the parent widget (QWidget) |
122 reference to the parent widget (QWidget) |
114 </dd> |
|
115 </dl><a NAME="HelpIndexWidget.__activated" ID="HelpIndexWidget.__activated"></a> |
|
116 <h4>HelpIndexWidget.__activated</h4> |
|
117 <b>__activated</b>(<i>idx</i>) |
|
118 <p> |
|
119 Private slot to handle the activation of a keyword entry. |
|
120 </p><dl> |
|
121 <dt><i>idx</i></dt> |
|
122 <dd> |
|
123 index of the activated entry (QModelIndex) |
|
124 </dd> |
123 </dd> |
125 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> |
124 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a> |
126 <h4>HelpIndexWidget.__disableSearchEdit</h4> |
125 <h4>HelpIndexWidget.__disableSearchEdit</h4> |
127 <b>__disableSearchEdit</b>(<i></i>) |
126 <b>__disableSearchEdit</b>(<i></i>) |
128 <p> |
127 <p> |
140 </p><dl> |
139 </p><dl> |
141 <dt><i>filter</i></dt> |
140 <dt><i>filter</i></dt> |
142 <dd> |
141 <dd> |
143 filter to be used (string) |
142 filter to be used (string) |
144 </dd> |
143 </dd> |
|
144 </dl><a NAME="HelpIndexWidget.__linkActivated" ID="HelpIndexWidget.__linkActivated"></a> |
|
145 <h4>HelpIndexWidget.__linkActivated</h4> |
|
146 <b>__linkActivated</b>(<i>url, keyword, modifiers=None</i>) |
|
147 <p> |
|
148 Private slot to handle the activation of a keyword entry. |
|
149 </p><dl> |
|
150 <dt><i>url</i> (QUrl)</dt> |
|
151 <dd> |
|
152 URL of the selected entry |
|
153 </dd><dt><i>keyword</i> (str)</dt> |
|
154 <dd> |
|
155 keyword for the URL |
|
156 </dd><dt><i>modifiers=</i> (Qt.KeyboardModifiers or None)</dt> |
|
157 <dd> |
|
158 keyboard modifiers |
|
159 </dd> |
|
160 </dl><a NAME="HelpIndexWidget.__linksActivated" ID="HelpIndexWidget.__linksActivated"></a> |
|
161 <h4>HelpIndexWidget.__linksActivated</h4> |
|
162 <b>__linksActivated</b>(<i>links, keyword</i>) |
|
163 <p> |
|
164 Private slot to handle the activation of an entry with multiple links. |
|
165 </p><dl> |
|
166 <dt><i>links</i> (dict of key:str and value:QUrl)</dt> |
|
167 <dd> |
|
168 dictionary containing the links |
|
169 </dd><dt><i>keyword</i> (str)</dt> |
|
170 <dd> |
|
171 keyword for the entry |
|
172 </dd> |
|
173 </dl><a NAME="HelpIndexWidget.__selectLink" ID="HelpIndexWidget.__selectLink"></a> |
|
174 <h4>HelpIndexWidget.__selectLink</h4> |
|
175 <b>__selectLink</b>(<i>links, keyword</i>) |
|
176 <p> |
|
177 Private method to give the user a chance to select among the |
|
178 returned links. |
|
179 </p><dl> |
|
180 <dt><i>links</i> (dictionary of str (key) and QUrl (value))</dt> |
|
181 <dd> |
|
182 dictionary of document title and URL to select from |
|
183 </dd><dt><i>keyword</i> (str)</dt> |
|
184 <dd> |
|
185 keyword for the link set |
|
186 </dd> |
|
187 </dl><dl> |
|
188 <dt>Returns:</dt> |
|
189 <dd> |
|
190 selected link |
|
191 </dd> |
|
192 </dl><dl> |
|
193 <dt>Return Type:</dt> |
|
194 <dd> |
|
195 QUrl |
|
196 </dd> |
|
197 </dl><a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a> |
|
198 <h4>HelpIndexWidget.__showContextMenu</h4> |
|
199 <b>__showContextMenu</b>(<i>pos</i>) |
|
200 <p> |
|
201 Private slot showing the context menu. |
|
202 </p><dl> |
|
203 <dt><i>pos</i></dt> |
|
204 <dd> |
|
205 position to show the menu at (QPoint) |
|
206 </dd> |
145 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> |
207 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a> |
146 <h4>HelpIndexWidget.eventFilter</h4> |
208 <h4>HelpIndexWidget.eventFilter</h4> |
147 <b>eventFilter</b>(<i>watched, event</i>) |
209 <b>eventFilter</b>(<i>watched, event</i>) |
148 <p> |
210 <p> |
149 Public method called to filter the event queue. |
211 Public method called to filter the event queue. |