Mercurial Repositories > eric / file comparison

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

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

branch
eric7
changeset 10479
856476537696
parent 10431
64157aeb0312
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.HelpTocWidget</h1> 9 <h1>eric7.QtHelpInterface.HelpTocWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a window for showing the QtHelp TOC. 11 Module implementing a window for showing the QtHelp TOC.
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="#HelpTocWidget">HelpTocWidget</a></td> 22 <td><a href="#HelpTocWidget">HelpTocWidget</a></td>
25 <td>Class implementing a window for showing the QtHelp TOC.</td> 23 <td>Class implementing a window for showing the QtHelp TOC.</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="HelpTocWidget" ID="HelpTocWidget"></a> 34 <a NAME="HelpTocWidget" ID="HelpTocWidget"></a>
36 <h2>HelpTocWidget</h2> 35 <h2>HelpTocWidget</h2>
37
38 <p> 36 <p>
39 Class implementing a window for showing the QtHelp TOC. 37 Class implementing a window for showing the QtHelp TOC.
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>
64 </dd> 63 </dd>
65 </dl> 64 </dl>
66 <h3>Derived from</h3> 65 <h3>Derived from</h3>
67 QWidget 66 QWidget
68 <h3>Class Attributes</h3> 67 <h3>Class Attributes</h3>
69 68 <table>
70 <table> 69 <tr><td>None</td></tr>
71 <tr><td>None</td></tr> 70 </table>
72 </table> 71
73 <h3>Class Methods</h3> 72 <h3>Class Methods</h3>
74 73 <table>
75 <table> 74 <tr><td>None</td></tr>
76 <tr><td>None</td></tr> 75 </table>
77 </table> 76
78 <h3>Methods</h3> 77 <h3>Methods</h3>
79 78 <table>
80 <table>
81
82 <tr> 79 <tr>
83 <td><a href="#HelpTocWidget.__init__">HelpTocWidget</a></td> 80 <td><a href="#HelpTocWidget.__init__">HelpTocWidget</a></td>
84 <td>Constructor</td> 81 <td>Constructor</td>
85 </tr> 82 </tr>
86 <tr> 83 <tr>
114 <tr> 111 <tr>
115 <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td> 112 <td><a href="#HelpTocWidget.syncToContent">syncToContent</a></td>
116 <td>Public method to sync the TOC to the displayed page.</td> 113 <td>Public method to sync the TOC to the displayed page.</td>
117 </tr> 114 </tr>
118 </table> 115 </table>
116
119 <h3>Static Methods</h3> 117 <h3>Static Methods</h3>
120 118 <table>
121 <table> 119 <tr><td>None</td></tr>
122 <tr><td>None</td></tr> 120 </table>
123 </table> 121
124 122
125 <a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a> 123 <a NAME="HelpTocWidget.__init__" ID="HelpTocWidget.__init__"></a>
126 <h4>HelpTocWidget (Constructor)</h4> 124 <h4>HelpTocWidget (Constructor)</h4>
127 <b>HelpTocWidget</b>(<i>engine, internal=False, parent=None</i>) 125 <b>HelpTocWidget</b>(<i>engine, internal=False, parent=None</i>)
128
129 <p> 126 <p>
130 Constructor 127 Constructor
131 </p> 128 </p>
129
132 <dl> 130 <dl>
133 131
134 <dt><i>engine</i> (QHelpEngine)</dt> 132 <dt><i>engine</i> (QHelpEngine)</dt>
135 <dd> 133 <dd>
136 reference to the help engine 134 reference to the help engine
145 </dd> 143 </dd>
146 </dl> 144 </dl>
147 <a NAME="HelpTocWidget.__contentsCreated" ID="HelpTocWidget.__contentsCreated"></a> 145 <a NAME="HelpTocWidget.__contentsCreated" ID="HelpTocWidget.__contentsCreated"></a>
148 <h4>HelpTocWidget.__contentsCreated</h4> 146 <h4>HelpTocWidget.__contentsCreated</h4>
149 <b>__contentsCreated</b>(<i></i>) 147 <b>__contentsCreated</b>(<i></i>)
150
151 <p> 148 <p>
152 Private slot to be run after the contents was generated. 149 Private slot to be run after the contents was generated.
153 </p> 150 </p>
151
154 <a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a> 152 <a NAME="HelpTocWidget.__expandTOC" ID="HelpTocWidget.__expandTOC"></a>
155 <h4>HelpTocWidget.__expandTOC</h4> 153 <h4>HelpTocWidget.__expandTOC</h4>
156 <b>__expandTOC</b>(<i></i>) 154 <b>__expandTOC</b>(<i></i>)
157
158 <p> 155 <p>
159 Private slot to expand the table of contents. 156 Private slot to expand the table of contents.
160 </p> 157 </p>
158
161 <a NAME="HelpTocWidget.__linkActivated" ID="HelpTocWidget.__linkActivated"></a> 159 <a NAME="HelpTocWidget.__linkActivated" ID="HelpTocWidget.__linkActivated"></a>
162 <h4>HelpTocWidget.__linkActivated</h4> 160 <h4>HelpTocWidget.__linkActivated</h4>
163 <b>__linkActivated</b>(<i>url</i>) 161 <b>__linkActivated</b>(<i>url</i>)
164
165 <p> 162 <p>
166 Private slot handling the activation of an entry. 163 Private slot handling the activation of an entry.
167 </p> 164 </p>
165
168 <dl> 166 <dl>
169 167
170 <dt><i>url</i> (QUrl)</dt> 168 <dt><i>url</i> (QUrl)</dt>
171 <dd> 169 <dd>
172 URL of the activated entry 170 URL of the activated entry
173 </dd> 171 </dd>
174 </dl> 172 </dl>
175 <a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a> 173 <a NAME="HelpTocWidget.__showContextMenu" ID="HelpTocWidget.__showContextMenu"></a>
176 <h4>HelpTocWidget.__showContextMenu</h4> 174 <h4>HelpTocWidget.__showContextMenu</h4>
177 <b>__showContextMenu</b>(<i>pos</i>) 175 <b>__showContextMenu</b>(<i>pos</i>)
178
179 <p> 176 <p>
180 Private slot showing the context menu. 177 Private slot showing the context menu.
181 </p> 178 </p>
179
182 <dl> 180 <dl>
183 181
184 <dt><i>pos</i> (QPoint)</dt> 182 <dt><i>pos</i> (QPoint)</dt>
185 <dd> 183 <dd>
186 position to show the menu at 184 position to show the menu at
187 </dd> 185 </dd>
188 </dl> 186 </dl>
189 <a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a> 187 <a NAME="HelpTocWidget.expandToDepth" ID="HelpTocWidget.expandToDepth"></a>
190 <h4>HelpTocWidget.expandToDepth</h4> 188 <h4>HelpTocWidget.expandToDepth</h4>
191 <b>expandToDepth</b>(<i>depth</i>) 189 <b>expandToDepth</b>(<i>depth</i>)
192
193 <p> 190 <p>
194 Public slot to expand the table of contents to a specific depth. 191 Public slot to expand the table of contents to a specific depth.
195 </p> 192 </p>
193
196 <dl> 194 <dl>
197 195
198 <dt><i>depth</i> (int)</dt> 196 <dt><i>depth</i> (int)</dt>
199 <dd> 197 <dd>
200 depth to expand to 198 depth to expand to
201 </dd> 199 </dd>
202 </dl> 200 </dl>
203 <a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a> 201 <a NAME="HelpTocWidget.focusInEvent" ID="HelpTocWidget.focusInEvent"></a>
204 <h4>HelpTocWidget.focusInEvent</h4> 202 <h4>HelpTocWidget.focusInEvent</h4>
205 <b>focusInEvent</b>(<i>evt</i>) 203 <b>focusInEvent</b>(<i>evt</i>)
206
207 <p> 204 <p>
208 Protected method handling focus in events. 205 Protected method handling focus in events.
209 </p> 206 </p>
207
210 <dl> 208 <dl>
211 209
212 <dt><i>evt</i> (QFocusEvent)</dt> 210 <dt><i>evt</i> (QFocusEvent)</dt>
213 <dd> 211 <dd>
214 reference to the focus event object 212 reference to the focus event object
215 </dd> 213 </dd>
216 </dl> 214 </dl>
217 <a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a> 215 <a NAME="HelpTocWidget.keyPressEvent" ID="HelpTocWidget.keyPressEvent"></a>
218 <h4>HelpTocWidget.keyPressEvent</h4> 216 <h4>HelpTocWidget.keyPressEvent</h4>
219 <b>keyPressEvent</b>(<i>evt</i>) 217 <b>keyPressEvent</b>(<i>evt</i>)
220
221 <p> 218 <p>
222 Protected method handling key press events. 219 Protected method handling key press events.
223 </p> 220 </p>
221
224 <dl> 222 <dl>
225 223
226 <dt><i>evt</i> (QKeyEvent)</dt> 224 <dt><i>evt</i> (QKeyEvent)</dt>
227 <dd> 225 <dd>
228 reference to the key press event 226 reference to the key press event
229 </dd> 227 </dd>
230 </dl> 228 </dl>
231 <a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a> 229 <a NAME="HelpTocWidget.syncToContent" ID="HelpTocWidget.syncToContent"></a>
232 <h4>HelpTocWidget.syncToContent</h4> 230 <h4>HelpTocWidget.syncToContent</h4>
233 <b>syncToContent</b>(<i>url</i>) 231 <b>syncToContent</b>(<i>url</i>)
234
235 <p> 232 <p>
236 Public method to sync the TOC to the displayed page. 233 Public method to sync the TOC to the displayed page.
237 </p> 234 </p>
235
238 <dl> 236 <dl>
239 237
240 <dt><i>url</i> (QUrl)</dt> 238 <dt><i>url</i> (QUrl)</dt>
241 <dd> 239 <dd>
242 URL of the displayed page 240 URL of the displayed page

Mercurial Repository: eric

eric ide

mercurial