Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html

eric6/Documentation/Source/eric6.WebBrowser.QtHelp.HelpIndexWidget.html

changeset 6942
2602857055c5
parent 5606
da305d172769
child 7273
391d6b7b1eff
equal deleted inserted replaced
6941:f99d60d6b59b 6942:2602857055c5
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.WebBrowser.QtHelp.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.WebBrowser.QtHelp.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>newBackgroundTab(QUrl, str)</dt>
52 <dd>
53 emitted to open an entry in a
54 new background tab
55 </dd><dt>newTab(QUrl, str)</dt>
56 <dd>
57 emitted to open an entry in a new tab
58 </dd><dt>newWindow(QUrl, str)</dt>
59 <dd>
60 emitted to open an entry in a new window
61 </dd><dt>openUrl(QUrl, str)</dt>
62 <dd>
63 emitted to open an entry in the current tab
64 </dd>
65 </dl>
66 <h3>Derived from</h3>
67 QWidget
68 <h3>Class Attributes</h3>
69 <table>
70 <tr><td>None</td></tr>
71 </table>
72 <h3>Class Methods</h3>
73 <table>
74 <tr><td>None</td></tr>
75 </table>
76 <h3>Methods</h3>
77 <table>
78 <tr>
79 <td><a href="#HelpIndexWidget.__init__">HelpIndexWidget</a></td>
80 <td>Constructor</td>
81 </tr><tr>
82 <td><a href="#HelpIndexWidget.__disableSearchEdit">__disableSearchEdit</a></td>
83 <td>Private slot to enable the search edit.</td>
84 </tr><tr>
85 <td><a href="#HelpIndexWidget.__enableSearchEdit">__enableSearchEdit</a></td>
86 <td>Private slot to enable the search edit.</td>
87 </tr><tr>
88 <td><a href="#HelpIndexWidget.__filterIndices">__filterIndices</a></td>
89 <td>Private slot to filter the indexes according to the given filter.</td>
90 </tr><tr>
91 <td><a href="#HelpIndexWidget.__linkActivated">__linkActivated</a></td>
92 <td>Private slot to handle the activation of a keyword entry.</td>
93 </tr><tr>
94 <td><a href="#HelpIndexWidget.__linksActivated">__linksActivated</a></td>
95 <td>Private slot to handle the activation of an entry with multiple links.</td>
96 </tr><tr>
97 <td><a href="#HelpIndexWidget.__selectLink">__selectLink</a></td>
98 <td>Private method to give the user a chance to select among the returned links.</td>
99 </tr><tr>
100 <td><a href="#HelpIndexWidget.__showContextMenu">__showContextMenu</a></td>
101 <td>Private slot showing the context menu.</td>
102 </tr><tr>
103 <td><a href="#HelpIndexWidget.eventFilter">eventFilter</a></td>
104 <td>Public method called to filter the event queue.</td>
105 </tr><tr>
106 <td><a href="#HelpIndexWidget.focusInEvent">focusInEvent</a></td>
107 <td>Protected method handling focus in events.</td>
108 </tr>
109 </table>
110 <h3>Static Methods</h3>
111 <table>
112 <tr><td>None</td></tr>
113 </table>
114 <a NAME="HelpIndexWidget.__init__" ID="HelpIndexWidget.__init__"></a>
115 <h4>HelpIndexWidget (Constructor)</h4>
116 <b>HelpIndexWidget</b>(<i>engine, parent=None</i>)
117 <p>
118 Constructor
119 </p><dl>
120 <dt><i>engine</i></dt>
121 <dd>
122 reference to the help engine (QHelpEngine)
123 </dd><dt><i>parent</i></dt>
124 <dd>
125 reference to the parent widget (QWidget)
126 </dd>
127 </dl><a NAME="HelpIndexWidget.__disableSearchEdit" ID="HelpIndexWidget.__disableSearchEdit"></a>
128 <h4>HelpIndexWidget.__disableSearchEdit</h4>
129 <b>__disableSearchEdit</b>(<i></i>)
130 <p>
131 Private slot to enable the search edit.
132 </p><a NAME="HelpIndexWidget.__enableSearchEdit" ID="HelpIndexWidget.__enableSearchEdit"></a>
133 <h4>HelpIndexWidget.__enableSearchEdit</h4>
134 <b>__enableSearchEdit</b>(<i></i>)
135 <p>
136 Private slot to enable the search edit.
137 </p><a NAME="HelpIndexWidget.__filterIndices" ID="HelpIndexWidget.__filterIndices"></a>
138 <h4>HelpIndexWidget.__filterIndices</h4>
139 <b>__filterIndices</b>(<i>indexFilter</i>)
140 <p>
141 Private slot to filter the indexes according to the given filter.
142 </p><dl>
143 <dt><i>indexFilter</i></dt>
144 <dd>
145 filter to be used (string)
146 </dd>
147 </dl><a NAME="HelpIndexWidget.__linkActivated" ID="HelpIndexWidget.__linkActivated"></a>
148 <h4>HelpIndexWidget.__linkActivated</h4>
149 <b>__linkActivated</b>(<i>url, keyword, modifiers=None</i>)
150 <p>
151 Private slot to handle the activation of a keyword entry.
152 </p><dl>
153 <dt><i>url</i> (QUrl)</dt>
154 <dd>
155 URL of the selected entry
156 </dd><dt><i>keyword</i> (str)</dt>
157 <dd>
158 keyword for the URL
159 </dd><dt><i>modifiers=</i> (Qt.KeyboardModifiers or None)</dt>
160 <dd>
161 keyboard modifiers
162 </dd>
163 </dl><a NAME="HelpIndexWidget.__linksActivated" ID="HelpIndexWidget.__linksActivated"></a>
164 <h4>HelpIndexWidget.__linksActivated</h4>
165 <b>__linksActivated</b>(<i>links, keyword</i>)
166 <p>
167 Private slot to handle the activation of an entry with multiple links.
168 </p><dl>
169 <dt><i>links</i> (dict of key:str and value:QUrl)</dt>
170 <dd>
171 dictionary containing the links
172 </dd><dt><i>keyword</i> (str)</dt>
173 <dd>
174 keyword for the entry
175 </dd>
176 </dl><a NAME="HelpIndexWidget.__selectLink" ID="HelpIndexWidget.__selectLink"></a>
177 <h4>HelpIndexWidget.__selectLink</h4>
178 <b>__selectLink</b>(<i>links, keyword</i>)
179 <p>
180 Private method to give the user a chance to select among the
181 returned links.
182 </p><dl>
183 <dt><i>links</i> (dictionary of str (key) and QUrl (value))</dt>
184 <dd>
185 dictionary of document title and URL to select from
186 </dd><dt><i>keyword</i> (str)</dt>
187 <dd>
188 keyword for the link set
189 </dd>
190 </dl><dl>
191 <dt>Returns:</dt>
192 <dd>
193 selected link
194 </dd>
195 </dl><dl>
196 <dt>Return Type:</dt>
197 <dd>
198 QUrl
199 </dd>
200 </dl><a NAME="HelpIndexWidget.__showContextMenu" ID="HelpIndexWidget.__showContextMenu"></a>
201 <h4>HelpIndexWidget.__showContextMenu</h4>
202 <b>__showContextMenu</b>(<i>pos</i>)
203 <p>
204 Private slot showing the context menu.
205 </p><dl>
206 <dt><i>pos</i></dt>
207 <dd>
208 position to show the menu at (QPoint)
209 </dd>
210 </dl><a NAME="HelpIndexWidget.eventFilter" ID="HelpIndexWidget.eventFilter"></a>
211 <h4>HelpIndexWidget.eventFilter</h4>
212 <b>eventFilter</b>(<i>watched, event</i>)
213 <p>
214 Public method called to filter the event queue.
215 </p><dl>
216 <dt><i>watched</i></dt>
217 <dd>
218 the QObject being watched (QObject)
219 </dd><dt><i>event</i></dt>
220 <dd>
221 the event that occurred (QEvent)
222 </dd>
223 </dl><dl>
224 <dt>Returns:</dt>
225 <dd>
226 flag indicating whether the event was handled (boolean)
227 </dd>
228 </dl><a NAME="HelpIndexWidget.focusInEvent" ID="HelpIndexWidget.focusInEvent"></a>
229 <h4>HelpIndexWidget.focusInEvent</h4>
230 <b>focusInEvent</b>(<i>evt</i>)
231 <p>
232 Protected method handling focus in events.
233 </p><dl>
234 <dt><i>evt</i></dt>
235 <dd>
236 reference to the focus event object (QFocusEvent)
237 </dd>
238 </dl>
239 <div align="right"><a href="#top">Up</a></div>
240 <hr />
241 </body></html>

Mercurial Repository: eric

eric ide

mercurial