Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.Helpviewer.HelpIndexWidget.html

eric6/Documentation/Source/eric6.Helpviewer.HelpIndexWidget.html

changeset 6942
2602857055c5
parent 5606
da305d172769
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.HelpIndexWidget</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.Helpviewer.HelpIndexWidget</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="#HelpIndexWidget">HelpIndexWidget</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="HelpIndexWidget" ID="HelpIndexWidget"></a>
43 <h2>HelpIndexWidget</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>linkActivated(QUrl)</dt>
52 <dd>
53 emitted when an index entry is activated
54 </dd><dt>linksActivated(links, keyword)</dt>
55 <dd>
56 emitted when an index entry
57 referencing multiple targets is activated
58 </dd>
59 </dl>
60 <h3>Derived from</h3>
61 QWidget
62 <h3>Class Attributes</h3>
63 <table>
64 <tr><td>None</td></tr>
65 </table>
66 <h3>Class Methods</h3>
67 <table>
68 <tr><td>None</td></tr>
69 </table>
70 <h3>Methods</h3>
71 <table>
72 <tr>
73 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td>
74 <td>Constructor</td>
75 </tr><tr>
76 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td>
77 <td>Private slot to enable the search edit.</td>
78 </tr><tr>
79 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td>
80 <td>Private slot to enable the search edit.</td>
81 </tr><tr>
82 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></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>
96 </tr><tr>
97 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td>
98 <td>Public method called to filter the event queue.</td>
99 </tr><tr>
100 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td>
101 <td>Protected method handling focus in events.</td>
102 </tr>
103 </table>
104 <h3>Static Methods</h3>
105 <table>
106 <tr><td>None</td></tr>
107 </table>
108 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a>
109 <h4>HelpIndexWidget (Constructor)</h4>
110 <b>HelpIndexWidget</b>(<i>engine, mainWindow, parent=None</i>)
111 <p>
112 Constructor
113 </p><dl>
114 <dt><i>engine</i></dt>
115 <dd>
116 reference to the help engine (QHelpEngine)
117 </dd><dt><i>mainWindow</i></dt>
118 <dd>
119 reference to the main window object (QMainWindow)
120 </dd><dt><i>parent</i></dt>
121 <dd>
122 reference to the parent widget (QWidget)
123 </dd>
124 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a>
125 <h4>HelpIndexWidget.__disableSearchEdit</h4>
126 <b>__disableSearchEdit</b>(<i></i>)
127 <p>
128 Private slot to enable the search edit.
129 </p><a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a>
130 <h4>HelpIndexWidget.__enableSearchEdit</h4>
131 <b>__enableSearchEdit</b>(<i></i>)
132 <p>
133 Private slot to enable the search edit.
134 </p><a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a>
135 <h4>HelpIndexWidget.__filterIndices</h4>
136 <b>__filterIndices</b>(<i>filterStr</i>)
137 <p>
138 Private slot to filter the indices according to the given filter.
139 </p><dl>
140 <dt><i>filterStr</i></dt>
141 <dd>
142 filter to be used (string)
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>
207 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a>
208 <h4>HelpIndexWidget.eventFilter</h4>
209 <b>eventFilter</b>(<i>watched, event</i>)
210 <p>
211 Public method called to filter the event queue.
212 </p><dl>
213 <dt><i>watched</i></dt>
214 <dd>
215 the QObject being watched (QObject)
216 </dd><dt><i>event</i></dt>
217 <dd>
218 the event that occurred (QEvent)
219 </dd>
220 </dl><dl>
221 <dt>Returns:</dt>
222 <dd>
223 flag indicating whether the event was handled (boolean)
224 </dd>
225 </dl><a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a>
226 <h4>HelpIndexWidget.focusInEvent</h4>
227 <b>focusInEvent</b>(<i>evt</i>)
228 <p>
229 Protected method handling focus in events.
230 </p><dl>
231 <dt><i>evt</i></dt>
232 <dd>
233 reference to the focus event object (QFocusEvent)
234 </dd>
235 </dl>
236 <div align="right"><a href="#top">Up</a></div>
237 <hr />
238 </body></html>

Mercurial Repository: eric

eric ide

mercurial