Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.UI.SymbolsWidget.html

eric6/Documentation/Source/eric6.UI.SymbolsWidget.html

branch
maintenance
changeset 6989
8b8cadf8d7e9
parent 6942
2602857055c5
child 7273
391d6b7b1eff
equal deleted inserted replaced
6938:7926553b7509 6989:8b8cadf8d7e9
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.UI.SymbolsWidget</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.UI.SymbolsWidget</h1>
23 <p>
24 Module implementing a widget to select a symbol in various formats.
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="#SymbolsModel">SymbolsModel</a></td>
34 <td>Class implementing the model for the symbols widget.</td>
35 </tr><tr>
36 <td><a href="#SymbolsWidget">SymbolsWidget</a></td>
37 <td>Class implementing a widget to select a symbol in various formats.</td>
38 </tr>
39 </table>
40 <h3>Functions</h3>
41 <table>
42 <tr><td>None</td></tr>
43 </table>
44 <hr /><hr />
45 <a NAME="SymbolsModel" ID="SymbolsModel"></a>
46 <h2>SymbolsModel</h2>
47 <p>
48 Class implementing the model for the symbols widget.
49 </p>
50 <h3>Derived from</h3>
51 QAbstractTableModel
52 <h3>Class Attributes</h3>
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57 <table>
58 <tr><td>None</td></tr>
59 </table>
60 <h3>Methods</h3>
61 <table>
62 <tr>
63 <td><a href="#SymbolsModel.__init__">SymbolsModel</a></td>
64 <td>Constructor</td>
65 </tr><tr>
66 <td><a href="#SymbolsModel.__isDigit">__isDigit</a></td>
67 <td>Private method to check, if a character is a digit.</td>
68 </tr><tr>
69 <td><a href="#SymbolsModel.__isLetter">__isLetter</a></td>
70 <td>Private method to check, if a character is a letter.</td>
71 </tr><tr>
72 <td><a href="#SymbolsModel.__isMark">__isMark</a></td>
73 <td>Private method to check, if a character is a mark character.</td>
74 </tr><tr>
75 <td><a href="#SymbolsModel.__isPunct">__isPunct</a></td>
76 <td>Private method to check, if a character is a punctuation character.</td>
77 </tr><tr>
78 <td><a href="#SymbolsModel.__isSymbol">__isSymbol</a></td>
79 <td>Private method to check, if a character is a symbol.</td>
80 </tr><tr>
81 <td><a href="#SymbolsModel.columnCount">columnCount</a></td>
82 <td>Public method to get the number of columns of the model.</td>
83 </tr><tr>
84 <td><a href="#SymbolsModel.data">data</a></td>
85 <td>Public method to get data from the model.</td>
86 </tr><tr>
87 <td><a href="#SymbolsModel.getLocale">getLocale</a></td>
88 <td>Public method to get the used locale.</td>
89 </tr><tr>
90 <td><a href="#SymbolsModel.getTableBoundaries">getTableBoundaries</a></td>
91 <td>Public method to get the first and last character position of the given table.</td>
92 </tr><tr>
93 <td><a href="#SymbolsModel.getTableIndex">getTableIndex</a></td>
94 <td>Public method to get the current table index.</td>
95 </tr><tr>
96 <td><a href="#SymbolsModel.getTableNames">getTableNames</a></td>
97 <td>Public method to get a list of table names.</td>
98 </tr><tr>
99 <td><a href="#SymbolsModel.headerData">headerData</a></td>
100 <td>Public method to get header data from the model.</td>
101 </tr><tr>
102 <td><a href="#SymbolsModel.rowCount">rowCount</a></td>
103 <td>Public method to get the number of rows of the model.</td>
104 </tr><tr>
105 <td><a href="#SymbolsModel.selectTable">selectTable</a></td>
106 <td>Public method to select the shown character table.</td>
107 </tr>
108 </table>
109 <h3>Static Methods</h3>
110 <table>
111 <tr><td>None</td></tr>
112 </table>
113 <a NAME="SymbolsModel.__init__" ID="SymbolsModel.__init__"></a>
114 <h4>SymbolsModel (Constructor)</h4>
115 <b>SymbolsModel</b>(<i>parent=None</i>)
116 <p>
117 Constructor
118 </p><dl>
119 <dt><i>parent</i></dt>
120 <dd>
121 reference to the parent object (QObject)
122 </dd>
123 </dl><a NAME="SymbolsModel.__isDigit" ID="SymbolsModel.__isDigit"></a>
124 <h4>SymbolsModel.__isDigit</h4>
125 <b>__isDigit</b>(<i>char</i>)
126 <p>
127 Private method to check, if a character is a digit.
128 </p><dl>
129 <dt><i>char</i></dt>
130 <dd>
131 character to test (one character string)
132 </dd>
133 </dl><dl>
134 <dt>Returns:</dt>
135 <dd>
136 flag indicating a digit (boolean)
137 </dd>
138 </dl><a NAME="SymbolsModel.__isLetter" ID="SymbolsModel.__isLetter"></a>
139 <h4>SymbolsModel.__isLetter</h4>
140 <b>__isLetter</b>(<i>char</i>)
141 <p>
142 Private method to check, if a character is a letter.
143 </p><dl>
144 <dt><i>char</i></dt>
145 <dd>
146 character to test (one character string)
147 </dd>
148 </dl><dl>
149 <dt>Returns:</dt>
150 <dd>
151 flag indicating a letter (boolean)
152 </dd>
153 </dl><a NAME="SymbolsModel.__isMark" ID="SymbolsModel.__isMark"></a>
154 <h4>SymbolsModel.__isMark</h4>
155 <b>__isMark</b>(<i>char</i>)
156 <p>
157 Private method to check, if a character is a mark character.
158 </p><dl>
159 <dt><i>char</i></dt>
160 <dd>
161 character to test (one character string)
162 </dd>
163 </dl><dl>
164 <dt>Returns:</dt>
165 <dd>
166 flag indicating a mark character (boolean)
167 </dd>
168 </dl><a NAME="SymbolsModel.__isPunct" ID="SymbolsModel.__isPunct"></a>
169 <h4>SymbolsModel.__isPunct</h4>
170 <b>__isPunct</b>(<i>char</i>)
171 <p>
172 Private method to check, if a character is a punctuation character.
173 </p><dl>
174 <dt><i>char</i></dt>
175 <dd>
176 character to test (one character string)
177 </dd>
178 </dl><dl>
179 <dt>Returns:</dt>
180 <dd>
181 flag indicating a punctuation character (boolean)
182 </dd>
183 </dl><a NAME="SymbolsModel.__isSymbol" ID="SymbolsModel.__isSymbol"></a>
184 <h4>SymbolsModel.__isSymbol</h4>
185 <b>__isSymbol</b>(<i>char</i>)
186 <p>
187 Private method to check, if a character is a symbol.
188 </p><dl>
189 <dt><i>char</i></dt>
190 <dd>
191 character to test (one character string)
192 </dd>
193 </dl><dl>
194 <dt>Returns:</dt>
195 <dd>
196 flag indicating a symbol (boolean)
197 </dd>
198 </dl><a NAME="SymbolsModel.columnCount" ID="SymbolsModel.columnCount"></a>
199 <h4>SymbolsModel.columnCount</h4>
200 <b>columnCount</b>(<i>parent</i>)
201 <p>
202 Public method to get the number of columns of the model.
203 </p><dl>
204 <dt><i>parent</i></dt>
205 <dd>
206 parent index (QModelIndex)
207 </dd>
208 </dl><dl>
209 <dt>Returns:</dt>
210 <dd>
211 number of columns (integer)
212 </dd>
213 </dl><a NAME="SymbolsModel.data" ID="SymbolsModel.data"></a>
214 <h4>SymbolsModel.data</h4>
215 <b>data</b>(<i>index, role=Qt.DisplayRole</i>)
216 <p>
217 Public method to get data from the model.
218 </p><dl>
219 <dt><i>index</i></dt>
220 <dd>
221 index to get data for (QModelIndex)
222 </dd><dt><i>role</i></dt>
223 <dd>
224 role of the data to retrieve (integer)
225 </dd>
226 </dl><dl>
227 <dt>Returns:</dt>
228 <dd>
229 requested data
230 </dd>
231 </dl><a NAME="SymbolsModel.getLocale" ID="SymbolsModel.getLocale"></a>
232 <h4>SymbolsModel.getLocale</h4>
233 <b>getLocale</b>(<i></i>)
234 <p>
235 Public method to get the used locale.
236 </p><dl>
237 <dt>Returns:</dt>
238 <dd>
239 used locale
240 </dd>
241 </dl><dl>
242 <dt>Return Type:</dt>
243 <dd>
244 QLocale
245 </dd>
246 </dl><a NAME="SymbolsModel.getTableBoundaries" ID="SymbolsModel.getTableBoundaries"></a>
247 <h4>SymbolsModel.getTableBoundaries</h4>
248 <b>getTableBoundaries</b>(<i>index</i>)
249 <p>
250 Public method to get the first and last character position
251 of the given table.
252 </p><dl>
253 <dt><i>index</i></dt>
254 <dd>
255 index of the character table (integer)
256 </dd>
257 </dl><dl>
258 <dt>Returns:</dt>
259 <dd>
260 first and last character position (integer, integer)
261 </dd>
262 </dl><a NAME="SymbolsModel.getTableIndex" ID="SymbolsModel.getTableIndex"></a>
263 <h4>SymbolsModel.getTableIndex</h4>
264 <b>getTableIndex</b>(<i></i>)
265 <p>
266 Public method to get the current table index.
267 </p><dl>
268 <dt>Returns:</dt>
269 <dd>
270 current table index (integer)
271 </dd>
272 </dl><a NAME="SymbolsModel.getTableNames" ID="SymbolsModel.getTableNames"></a>
273 <h4>SymbolsModel.getTableNames</h4>
274 <b>getTableNames</b>(<i></i>)
275 <p>
276 Public method to get a list of table names.
277 </p><dl>
278 <dt>Returns:</dt>
279 <dd>
280 list of table names (list of strings)
281 </dd>
282 </dl><a NAME="SymbolsModel.headerData" ID="SymbolsModel.headerData"></a>
283 <h4>SymbolsModel.headerData</h4>
284 <b>headerData</b>(<i>section, orientation, role=Qt.DisplayRole</i>)
285 <p>
286 Public method to get header data from the model.
287 </p><dl>
288 <dt><i>section</i></dt>
289 <dd>
290 section number (integer)
291 </dd><dt><i>orientation</i></dt>
292 <dd>
293 orientation (Qt.Orientation)
294 </dd><dt><i>role</i></dt>
295 <dd>
296 role of the data to retrieve (integer)
297 </dd>
298 </dl><dl>
299 <dt>Returns:</dt>
300 <dd>
301 requested data
302 </dd>
303 </dl><a NAME="SymbolsModel.rowCount" ID="SymbolsModel.rowCount"></a>
304 <h4>SymbolsModel.rowCount</h4>
305 <b>rowCount</b>(<i>parent</i>)
306 <p>
307 Public method to get the number of rows of the model.
308 </p><dl>
309 <dt><i>parent</i></dt>
310 <dd>
311 parent index (QModelIndex)
312 </dd>
313 </dl><dl>
314 <dt>Returns:</dt>
315 <dd>
316 number of columns (integer)
317 </dd>
318 </dl><a NAME="SymbolsModel.selectTable" ID="SymbolsModel.selectTable"></a>
319 <h4>SymbolsModel.selectTable</h4>
320 <b>selectTable</b>(<i>index</i>)
321 <p>
322 Public method to select the shown character table.
323 </p><dl>
324 <dt><i>index</i></dt>
325 <dd>
326 index of the character table (integer)
327 </dd>
328 </dl>
329 <div align="right"><a href="#top">Up</a></div>
330 <hr /><hr />
331 <a NAME="SymbolsWidget" ID="SymbolsWidget"></a>
332 <h2>SymbolsWidget</h2>
333 <p>
334 Class implementing a widget to select a symbol in various formats.
335 </p><h3>Signals</h3>
336 <dl>
337 <dt>insertSymbol(str)</dt>
338 <dd>
339 emitted after the user has selected a symbol
340 </dd>
341 </dl>
342 <h3>Derived from</h3>
343 QWidget, Ui_SymbolsWidget
344 <h3>Class Attributes</h3>
345 <table>
346 <tr><td>None</td></tr>
347 </table>
348 <h3>Class Methods</h3>
349 <table>
350 <tr><td>None</td></tr>
351 </table>
352 <h3>Methods</h3>
353 <table>
354 <tr>
355 <td><a href="#SymbolsWidget.__init__">SymbolsWidget</a></td>
356 <td>Constructor</td>
357 </tr><tr>
358 <td><a href="#SymbolsWidget.__currentRowChanged">__currentRowChanged</a></td>
359 <td>Private slot recording the currently selected row.</td>
360 </tr><tr>
361 <td><a href="#SymbolsWidget.on_symbolSpinBox_editingFinished">on_symbolSpinBox_editingFinished</a></td>
362 <td>Private slot to move the table to the entered symbol id.</td>
363 </tr><tr>
364 <td><a href="#SymbolsWidget.on_symbolsTable_activated">on_symbolsTable_activated</a></td>
365 <td>Private slot to signal the selection of a symbol.</td>
366 </tr><tr>
367 <td><a href="#SymbolsWidget.on_tableCombo_currentIndexChanged">on_tableCombo_currentIndexChanged</a></td>
368 <td>Private slot to select the current character table.</td>
369 </tr>
370 </table>
371 <h3>Static Methods</h3>
372 <table>
373 <tr><td>None</td></tr>
374 </table>
375 <a NAME="SymbolsWidget.__init__" ID="SymbolsWidget.__init__"></a>
376 <h4>SymbolsWidget (Constructor)</h4>
377 <b>SymbolsWidget</b>(<i>parent=None</i>)
378 <p>
379 Constructor
380 </p><dl>
381 <dt><i>parent</i></dt>
382 <dd>
383 reference to the parent widget (QWidget)
384 </dd>
385 </dl><a NAME="SymbolsWidget.__currentRowChanged" ID="SymbolsWidget.__currentRowChanged"></a>
386 <h4>SymbolsWidget.__currentRowChanged</h4>
387 <b>__currentRowChanged</b>(<i>current, previous</i>)
388 <p>
389 Private slot recording the currently selected row.
390 </p><dl>
391 <dt><i>current</i></dt>
392 <dd>
393 current index (QModelIndex)
394 </dd><dt><i>previous</i></dt>
395 <dd>
396 previous current index (QModelIndex)
397 </dd>
398 </dl><a NAME="SymbolsWidget.on_symbolSpinBox_editingFinished" ID="SymbolsWidget.on_symbolSpinBox_editingFinished"></a>
399 <h4>SymbolsWidget.on_symbolSpinBox_editingFinished</h4>
400 <b>on_symbolSpinBox_editingFinished</b>(<i></i>)
401 <p>
402 Private slot to move the table to the entered symbol id.
403 </p><a NAME="SymbolsWidget.on_symbolsTable_activated" ID="SymbolsWidget.on_symbolsTable_activated"></a>
404 <h4>SymbolsWidget.on_symbolsTable_activated</h4>
405 <b>on_symbolsTable_activated</b>(<i>index</i>)
406 <p>
407 Private slot to signal the selection of a symbol.
408 </p><dl>
409 <dt><i>index</i></dt>
410 <dd>
411 index of the selected symbol (QModelIndex)
412 </dd>
413 </dl><a NAME="SymbolsWidget.on_tableCombo_currentIndexChanged" ID="SymbolsWidget.on_tableCombo_currentIndexChanged"></a>
414 <h4>SymbolsWidget.on_tableCombo_currentIndexChanged</h4>
415 <b>on_tableCombo_currentIndexChanged</b>(<i>index</i>)
416 <p>
417 Private slot to select the current character table.
418 </p><dl>
419 <dt><i>index</i></dt>
420 <dd>
421 index of the character table (integer)
422 </dd>
423 </dl>
424 <div align="right"><a href="#top">Up</a></div>
425 <hr />
426 </body></html>

Mercurial Repository: eric

eric ide

mercurial