src/eric7/Documentation/Source/eric7.Preferences.ConfigurationPages.DebuggerGeneralPage.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9530
c30f02ea1b27
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.Preferences.ConfigurationPages.DebuggerGeneralPage</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.Preferences.ConfigurationPages.DebuggerGeneralPage</h1>
10
11 <p>
12 Module implementing the Debugger General configuration page.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#DebuggerGeneralPage">DebuggerGeneralPage</a></td>
25 <td>Class implementing the Debugger General configuration page.</td>
26 </tr>
27 <tr>
28 <td><a href="#PreviewModel">PreviewModel</a></td>
29 <td>Class to show an example of the selected background colours for the debug viewer.</td>
30 </tr>
31 </table>
32 <h3>Functions</h3>
33
34 <table>
35
36 <tr>
37 <td><a href="#create">create</a></td>
38 <td>Module function to create the configuration page.</td>
39 </tr>
40 </table>
41 <hr />
42 <hr />
43 <a NAME="DebuggerGeneralPage" ID="DebuggerGeneralPage"></a>
44 <h2>DebuggerGeneralPage</h2>
45
46 <p>
47 Class implementing the Debugger General configuration page.
48 </p>
49 <h3>Derived from</h3>
50 ConfigurationPageBase, Ui_DebuggerGeneralPage
51 <h3>Class Attributes</h3>
52
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62
63 <table>
64
65 <tr>
66 <td><a href="#DebuggerGeneralPage.__init__">DebuggerGeneralPage</a></td>
67 <td>Constructor</td>
68 </tr>
69 <tr>
70 <td><a href="#DebuggerGeneralPage.on_addAllowedHostButton_clicked">on_addAllowedHostButton_clicked</a></td>
71 <td>Private slot called to add a new allowed host.</td>
72 </tr>
73 <tr>
74 <td><a href="#DebuggerGeneralPage.on_allowedHostsList_currentItemChanged">on_allowedHostsList_currentItemChanged</a></td>
75 <td>Private method set the state of the edit and delete button.</td>
76 </tr>
77 <tr>
78 <td><a href="#DebuggerGeneralPage.on_deleteAllowedHostButton_clicked">on_deleteAllowedHostButton_clicked</a></td>
79 <td>Private slot called to delete an allowed host.</td>
80 </tr>
81 <tr>
82 <td><a href="#DebuggerGeneralPage.on_editAllowedHostButton_clicked">on_editAllowedHostButton_clicked</a></td>
83 <td>Private slot called to edit an allowed host.</td>
84 </tr>
85 <tr>
86 <td><a href="#DebuggerGeneralPage.save">save</a></td>
87 <td>Public slot to save the Debugger General (1) configuration.</td>
88 </tr>
89 </table>
90 <h3>Static Methods</h3>
91
92 <table>
93 <tr><td>None</td></tr>
94 </table>
95
96 <a NAME="DebuggerGeneralPage.__init__" ID="DebuggerGeneralPage.__init__"></a>
97 <h4>DebuggerGeneralPage (Constructor)</h4>
98 <b>DebuggerGeneralPage</b>(<i></i>)
99
100 <p>
101 Constructor
102 </p>
103 <a NAME="DebuggerGeneralPage.on_addAllowedHostButton_clicked" ID="DebuggerGeneralPage.on_addAllowedHostButton_clicked"></a>
104 <h4>DebuggerGeneralPage.on_addAllowedHostButton_clicked</h4>
105 <b>on_addAllowedHostButton_clicked</b>(<i></i>)
106
107 <p>
108 Private slot called to add a new allowed host.
109 </p>
110 <a NAME="DebuggerGeneralPage.on_allowedHostsList_currentItemChanged" ID="DebuggerGeneralPage.on_allowedHostsList_currentItemChanged"></a>
111 <h4>DebuggerGeneralPage.on_allowedHostsList_currentItemChanged</h4>
112 <b>on_allowedHostsList_currentItemChanged</b>(<i>current, previous</i>)
113
114 <p>
115 Private method set the state of the edit and delete button.
116 </p>
117 <dl>
118
119 <dt><i>current</i></dt>
120 <dd>
121 new current item (QListWidgetItem)
122 </dd>
123 <dt><i>previous</i></dt>
124 <dd>
125 previous current item (QListWidgetItem)
126 </dd>
127 </dl>
128 <a NAME="DebuggerGeneralPage.on_deleteAllowedHostButton_clicked" ID="DebuggerGeneralPage.on_deleteAllowedHostButton_clicked"></a>
129 <h4>DebuggerGeneralPage.on_deleteAllowedHostButton_clicked</h4>
130 <b>on_deleteAllowedHostButton_clicked</b>(<i></i>)
131
132 <p>
133 Private slot called to delete an allowed host.
134 </p>
135 <a NAME="DebuggerGeneralPage.on_editAllowedHostButton_clicked" ID="DebuggerGeneralPage.on_editAllowedHostButton_clicked"></a>
136 <h4>DebuggerGeneralPage.on_editAllowedHostButton_clicked</h4>
137 <b>on_editAllowedHostButton_clicked</b>(<i></i>)
138
139 <p>
140 Private slot called to edit an allowed host.
141 </p>
142 <a NAME="DebuggerGeneralPage.save" ID="DebuggerGeneralPage.save"></a>
143 <h4>DebuggerGeneralPage.save</h4>
144 <b>save</b>(<i></i>)
145
146 <p>
147 Public slot to save the Debugger General (1) configuration.
148 </p>
149 <div align="right"><a href="#top">Up</a></div>
150 <hr />
151 <hr />
152 <a NAME="PreviewModel" ID="PreviewModel"></a>
153 <h2>PreviewModel</h2>
154
155 <p>
156 Class to show an example of the selected background colours for the debug
157 viewer.
158 </p>
159 <h3>Derived from</h3>
160 QAbstractItemModel
161 <h3>Class Attributes</h3>
162
163 <table>
164 <tr><td>None</td></tr>
165 </table>
166 <h3>Class Methods</h3>
167
168 <table>
169 <tr><td>None</td></tr>
170 </table>
171 <h3>Methods</h3>
172
173 <table>
174
175 <tr>
176 <td><a href="#PreviewModel.__init__">PreviewModel</a></td>
177 <td>Constructor</td>
178 </tr>
179 <tr>
180 <td><a href="#PreviewModel.columnCount">columnCount</a></td>
181 <td>Public Qt slot to get the column count.</td>
182 </tr>
183 <tr>
184 <td><a href="#PreviewModel.data">data</a></td>
185 <td>Public Qt slot get the role data of item.</td>
186 </tr>
187 <tr>
188 <td><a href="#PreviewModel.flags">flags</a></td>
189 <td>Public Qt slot to get the item flags.</td>
190 </tr>
191 <tr>
192 <td><a href="#PreviewModel.index">index</a></td>
193 <td>Public Qt slot to get the index of item at row:column of parent.</td>
194 </tr>
195 <tr>
196 <td><a href="#PreviewModel.parent">parent</a></td>
197 <td>Public Qt slot to get the parent of the given child.</td>
198 </tr>
199 <tr>
200 <td><a href="#PreviewModel.rowCount">rowCount</a></td>
201 <td>Public Qt slot to get the row count.</td>
202 </tr>
203 <tr>
204 <td><a href="#PreviewModel.setColor">setColor</a></td>
205 <td>Public slot to update the background colour indexed by key.</td>
206 </tr>
207 </table>
208 <h3>Static Methods</h3>
209
210 <table>
211 <tr><td>None</td></tr>
212 </table>
213
214 <a NAME="PreviewModel.__init__" ID="PreviewModel.__init__"></a>
215 <h4>PreviewModel (Constructor)</h4>
216 <b>PreviewModel</b>(<i></i>)
217
218 <p>
219 Constructor
220 </p>
221 <a NAME="PreviewModel.columnCount" ID="PreviewModel.columnCount"></a>
222 <h4>PreviewModel.columnCount</h4>
223 <b>columnCount</b>(<i>parent=QModelIndex()</i>)
224
225 <p>
226 Public Qt slot to get the column count.
227 </p>
228 <dl>
229
230 <dt><i>parent</i> (QModelIndex)</dt>
231 <dd>
232 the model parent
233 </dd>
234 </dl>
235 <dl>
236 <dt>Return:</dt>
237 <dd>
238 number of columns
239 </dd>
240 </dl>
241 <dl>
242 <dt>Return Type:</dt>
243 <dd>
244 int
245 </dd>
246 </dl>
247 <a NAME="PreviewModel.data" ID="PreviewModel.data"></a>
248 <h4>PreviewModel.data</h4>
249 <b>data</b>(<i>index, role=Qt.ItemDataRole.DisplayRole</i>)
250
251 <p>
252 Public Qt slot get the role data of item.
253 </p>
254 <dl>
255
256 <dt><i>index</i> (QModelIndex)</dt>
257 <dd>
258 the model index
259 </dd>
260 <dt><i>role</i> (QtCore.Qt.ItemDataRole)</dt>
261 <dd>
262 the requested data role
263 </dd>
264 </dl>
265 <dl>
266 <dt>Return:</dt>
267 <dd>
268 role data of item
269 </dd>
270 </dl>
271 <dl>
272 <dt>Return Type:</dt>
273 <dd>
274 str, QBrush or None
275 </dd>
276 </dl>
277 <a NAME="PreviewModel.flags" ID="PreviewModel.flags"></a>
278 <h4>PreviewModel.flags</h4>
279 <b>flags</b>(<i>index</i>)
280
281 <p>
282 Public Qt slot to get the item flags.
283 </p>
284 <dl>
285
286 <dt><i>index</i> (QModelIndex)</dt>
287 <dd>
288 of item
289 </dd>
290 </dl>
291 <dl>
292 <dt>Return:</dt>
293 <dd>
294 item flags
295 </dd>
296 </dl>
297 <dl>
298 <dt>Return Type:</dt>
299 <dd>
300 QtCore.Qt.ItemFlag
301 </dd>
302 </dl>
303 <a NAME="PreviewModel.index" ID="PreviewModel.index"></a>
304 <h4>PreviewModel.index</h4>
305 <b>index</b>(<i>row, column, parent=QModelIndex()</i>)
306
307 <p>
308 Public Qt slot to get the index of item at row:column of parent.
309 </p>
310 <dl>
311
312 <dt><i>row</i> (int)</dt>
313 <dd>
314 number of rows
315 </dd>
316 <dt><i>column</i> (int)</dt>
317 <dd>
318 number of columns
319 </dd>
320 <dt><i>parent</i> (QModelIndex)</dt>
321 <dd>
322 the model parent
323 </dd>
324 </dl>
325 <dl>
326 <dt>Return:</dt>
327 <dd>
328 new model index for child
329 </dd>
330 </dl>
331 <dl>
332 <dt>Return Type:</dt>
333 <dd>
334 QModelIndex
335 </dd>
336 </dl>
337 <a NAME="PreviewModel.parent" ID="PreviewModel.parent"></a>
338 <h4>PreviewModel.parent</h4>
339 <b>parent</b>(<i>child</i>)
340
341 <p>
342 Public Qt slot to get the parent of the given child.
343 </p>
344 <dl>
345
346 <dt><i>child</i> (QModelIndex)</dt>
347 <dd>
348 the model child node
349 </dd>
350 </dl>
351 <dl>
352 <dt>Return:</dt>
353 <dd>
354 new model index for parent
355 </dd>
356 </dl>
357 <dl>
358 <dt>Return Type:</dt>
359 <dd>
360 QModelIndex
361 </dd>
362 </dl>
363 <a NAME="PreviewModel.rowCount" ID="PreviewModel.rowCount"></a>
364 <h4>PreviewModel.rowCount</h4>
365 <b>rowCount</b>(<i>parent=QModelIndex()</i>)
366
367 <p>
368 Public Qt slot to get the row count.
369 </p>
370 <dl>
371
372 <dt><i>parent</i> (QModelIndex)</dt>
373 <dd>
374 the model parent
375 </dd>
376 </dl>
377 <dl>
378 <dt>Return:</dt>
379 <dd>
380 number of rows
381 </dd>
382 </dl>
383 <dl>
384 <dt>Return Type:</dt>
385 <dd>
386 int
387 </dd>
388 </dl>
389 <a NAME="PreviewModel.setColor" ID="PreviewModel.setColor"></a>
390 <h4>PreviewModel.setColor</h4>
391 <b>setColor</b>(<i>key, bgcolour</i>)
392
393 <p>
394 Public slot to update the background colour indexed by key.
395 </p>
396 <dl>
397
398 <dt><i>key</i> (str)</dt>
399 <dd>
400 the name of background
401 </dd>
402 <dt><i>bgcolour</i> (QColor)</dt>
403 <dd>
404 the new background colour
405 </dd>
406 </dl>
407 <div align="right"><a href="#top">Up</a></div>
408 <hr />
409 <hr />
410 <a NAME="create" ID="create"></a>
411 <h2>create</h2>
412 <b>create</b>(<i>dlg</i>)
413
414 <p>
415 Module function to create the configuration page.
416 </p>
417 <dl>
418
419 <dt><i>dlg</i></dt>
420 <dd>
421 reference to the configuration dialog
422 </dd>
423 </dl>
424 <dl>
425 <dt>Return:</dt>
426 <dd>
427 reference to the instantiated page (ConfigurationPageBase)
428 </dd>
429 </dl>
430 <div align="right"><a href="#top">Up</a></div>
431 <hr />
432 </body></html>

eric ide

mercurial