Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.EricWidgets.EricLineEdit.html
src/eric7/Documentation/Source/eric7.EricWidgets.EricLineEdit.html
- branch
- eric7
- changeset 9209
- b99e7fd55fd3
- parent 8596
- d64760b2da50
- child 10423
- 299802979277
equal
deleted
inserted
replaced
| 9208:3fc8dfeb6ebe | 9209:b99e7fd55fd3 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.EricWidgets.EricLineEdit</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.EricWidgets.EricLineEdit</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing specialized line edits. | |
| 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="#EricClearableLineEdit">EricClearableLineEdit</a></td> | |
| 25 <td>Class implementing a line edit widget showing some inactive text and a clear button, if it has some contents.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#EricLineEdit">EricLineEdit</a></td> | |
| 29 <td>Class implementing a line edit widget showing some inactive text.</td> | |
| 30 </tr> | |
| 31 <tr> | |
| 32 <td><a href="#EricLineEditSide">EricLineEditSide</a></td> | |
| 33 <td>Class defining the line edit sides.</td> | |
| 34 </tr> | |
| 35 <tr> | |
| 36 <td><a href="#EricLineEditSideWidget">EricLineEditSideWidget</a></td> | |
| 37 <td>Class implementing the side widgets for the line edit class.</td> | |
| 38 </tr> | |
| 39 </table> | |
| 40 <h3>Functions</h3> | |
| 41 | |
| 42 <table> | |
| 43 <tr><td>None</td></tr> | |
| 44 </table> | |
| 45 <hr /> | |
| 46 <hr /> | |
| 47 <a NAME="EricClearableLineEdit" ID="EricClearableLineEdit"></a> | |
| 48 <h2>EricClearableLineEdit</h2> | |
| 49 | |
| 50 <p> | |
| 51 Class implementing a line edit widget showing some inactive text and a | |
| 52 clear button, if it has some contents. | |
| 53 </p> | |
| 54 <h3>Derived from</h3> | |
| 55 EricLineEdit | |
| 56 <h3>Class Attributes</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Class Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Methods</h3> | |
| 67 | |
| 68 <table> | |
| 69 | |
| 70 <tr> | |
| 71 <td><a href="#EricClearableLineEdit.__init__">EricClearableLineEdit</a></td> | |
| 72 <td>Constructor</td> | |
| 73 </tr> | |
| 74 </table> | |
| 75 <h3>Static Methods</h3> | |
| 76 | |
| 77 <table> | |
| 78 <tr><td>None</td></tr> | |
| 79 </table> | |
| 80 | |
| 81 <a NAME="EricClearableLineEdit.__init__" ID="EricClearableLineEdit.__init__"></a> | |
| 82 <h4>EricClearableLineEdit (Constructor)</h4> | |
| 83 <b>EricClearableLineEdit</b>(<i>parent=None, placeholderText="", side=EricLineEditSide.RIGHT</i>) | |
| 84 | |
| 85 <p> | |
| 86 Constructor | |
| 87 </p> | |
| 88 <dl> | |
| 89 | |
| 90 <dt><i>parent</i> (QWidget)</dt> | |
| 91 <dd> | |
| 92 reference to the parent widget | |
| 93 </dd> | |
| 94 <dt><i>placeholderText</i> (str)</dt> | |
| 95 <dd> | |
| 96 text to be shown on inactivity | |
| 97 </dd> | |
| 98 <dt><i>side</i> (EricLineEditSide)</dt> | |
| 99 <dd> | |
| 100 side the clear button should be shown at | |
| 101 </dd> | |
| 102 </dl> | |
| 103 <div align="right"><a href="#top">Up</a></div> | |
| 104 <hr /> | |
| 105 <hr /> | |
| 106 <a NAME="EricLineEdit" ID="EricLineEdit"></a> | |
| 107 <h2>EricLineEdit</h2> | |
| 108 | |
| 109 <p> | |
| 110 Class implementing a line edit widget showing some inactive text. | |
| 111 </p> | |
| 112 <h3>Derived from</h3> | |
| 113 QLineEdit | |
| 114 <h3>Class Attributes</h3> | |
| 115 | |
| 116 <table> | |
| 117 <tr><td>None</td></tr> | |
| 118 </table> | |
| 119 <h3>Class Methods</h3> | |
| 120 | |
| 121 <table> | |
| 122 <tr><td>None</td></tr> | |
| 123 </table> | |
| 124 <h3>Methods</h3> | |
| 125 | |
| 126 <table> | |
| 127 | |
| 128 <tr> | |
| 129 <td><a href="#EricLineEdit.__init__">EricLineEdit</a></td> | |
| 130 <td>Constructor</td> | |
| 131 </tr> | |
| 132 <tr> | |
| 133 <td><a href="#EricLineEdit._updateTextMargins">_updateTextMargins</a></td> | |
| 134 <td>Protected slot to update the text margins.</td> | |
| 135 </tr> | |
| 136 <tr> | |
| 137 <td><a href="#EricLineEdit.addWidget">addWidget</a></td> | |
| 138 <td>Public method to add a widget to a side.</td> | |
| 139 </tr> | |
| 140 <tr> | |
| 141 <td><a href="#EricLineEdit.event">event</a></td> | |
| 142 <td>Public method to handle events.</td> | |
| 143 </tr> | |
| 144 <tr> | |
| 145 <td><a href="#EricLineEdit.leftMargin">leftMargin</a></td> | |
| 146 <td>Public method to get the size of the left margin.</td> | |
| 147 </tr> | |
| 148 <tr> | |
| 149 <td><a href="#EricLineEdit.removeWidget">removeWidget</a></td> | |
| 150 <td>Public method to remove a widget from a side.</td> | |
| 151 </tr> | |
| 152 <tr> | |
| 153 <td><a href="#EricLineEdit.setLeftMargin">setLeftMargin</a></td> | |
| 154 <td>Public method to set the left margin.</td> | |
| 155 </tr> | |
| 156 <tr> | |
| 157 <td><a href="#EricLineEdit.setWidgetSpacing">setWidgetSpacing</a></td> | |
| 158 <td>Public method to set the side widget spacing.</td> | |
| 159 </tr> | |
| 160 <tr> | |
| 161 <td><a href="#EricLineEdit.textMargin">textMargin</a></td> | |
| 162 <td>Public method to get the text margin for a side.</td> | |
| 163 </tr> | |
| 164 <tr> | |
| 165 <td><a href="#EricLineEdit.widgetSpacing">widgetSpacing</a></td> | |
| 166 <td>Public method to get the side widget spacing.</td> | |
| 167 </tr> | |
| 168 </table> | |
| 169 <h3>Static Methods</h3> | |
| 170 | |
| 171 <table> | |
| 172 <tr><td>None</td></tr> | |
| 173 </table> | |
| 174 | |
| 175 <a NAME="EricLineEdit.__init__" ID="EricLineEdit.__init__"></a> | |
| 176 <h4>EricLineEdit (Constructor)</h4> | |
| 177 <b>EricLineEdit</b>(<i>parent=None, placeholderText=""</i>) | |
| 178 | |
| 179 <p> | |
| 180 Constructor | |
| 181 </p> | |
| 182 <dl> | |
| 183 | |
| 184 <dt><i>parent</i> (QWidget)</dt> | |
| 185 <dd> | |
| 186 reference to the parent widget | |
| 187 </dd> | |
| 188 <dt><i>placeholderText</i> (str)</dt> | |
| 189 <dd> | |
| 190 text to be shown on inactivity | |
| 191 </dd> | |
| 192 </dl> | |
| 193 <a NAME="EricLineEdit._updateTextMargins" ID="EricLineEdit._updateTextMargins"></a> | |
| 194 <h4>EricLineEdit._updateTextMargins</h4> | |
| 195 <b>_updateTextMargins</b>(<i></i>) | |
| 196 | |
| 197 <p> | |
| 198 Protected slot to update the text margins. | |
| 199 </p> | |
| 200 <a NAME="EricLineEdit.addWidget" ID="EricLineEdit.addWidget"></a> | |
| 201 <h4>EricLineEdit.addWidget</h4> | |
| 202 <b>addWidget</b>(<i>widget, position</i>) | |
| 203 | |
| 204 <p> | |
| 205 Public method to add a widget to a side. | |
| 206 </p> | |
| 207 <dl> | |
| 208 | |
| 209 <dt><i>widget</i> (QWidget)</dt> | |
| 210 <dd> | |
| 211 reference to the widget to add | |
| 212 </dd> | |
| 213 <dt><i>position</i> (EricLineEditSide)</dt> | |
| 214 <dd> | |
| 215 position to add to | |
| 216 </dd> | |
| 217 </dl> | |
| 218 <a NAME="EricLineEdit.event" ID="EricLineEdit.event"></a> | |
| 219 <h4>EricLineEdit.event</h4> | |
| 220 <b>event</b>(<i>evt</i>) | |
| 221 | |
| 222 <p> | |
| 223 Public method to handle events. | |
| 224 </p> | |
| 225 <dl> | |
| 226 | |
| 227 <dt><i>evt</i></dt> | |
| 228 <dd> | |
| 229 reference to the event (QEvent) | |
| 230 </dd> | |
| 231 </dl> | |
| 232 <dl> | |
| 233 <dt>Return:</dt> | |
| 234 <dd> | |
| 235 flag indicating, whether the event was recognized (boolean) | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <a NAME="EricLineEdit.leftMargin" ID="EricLineEdit.leftMargin"></a> | |
| 239 <h4>EricLineEdit.leftMargin</h4> | |
| 240 <b>leftMargin</b>(<i></i>) | |
| 241 | |
| 242 <p> | |
| 243 Public method to get the size of the left margin. | |
| 244 </p> | |
| 245 <dl> | |
| 246 <dt>Return:</dt> | |
| 247 <dd> | |
| 248 left margin in pixel (integer) | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <a NAME="EricLineEdit.removeWidget" ID="EricLineEdit.removeWidget"></a> | |
| 252 <h4>EricLineEdit.removeWidget</h4> | |
| 253 <b>removeWidget</b>(<i>widget</i>) | |
| 254 | |
| 255 <p> | |
| 256 Public method to remove a widget from a side. | |
| 257 </p> | |
| 258 <dl> | |
| 259 | |
| 260 <dt><i>widget</i> (QWidget)</dt> | |
| 261 <dd> | |
| 262 reference to the widget to remove | |
| 263 </dd> | |
| 264 </dl> | |
| 265 <a NAME="EricLineEdit.setLeftMargin" ID="EricLineEdit.setLeftMargin"></a> | |
| 266 <h4>EricLineEdit.setLeftMargin</h4> | |
| 267 <b>setLeftMargin</b>(<i>margin</i>) | |
| 268 | |
| 269 <p> | |
| 270 Public method to set the left margin. | |
| 271 </p> | |
| 272 <dl> | |
| 273 | |
| 274 <dt><i>margin</i></dt> | |
| 275 <dd> | |
| 276 left margin in pixel (integer) | |
| 277 </dd> | |
| 278 </dl> | |
| 279 <a NAME="EricLineEdit.setWidgetSpacing" ID="EricLineEdit.setWidgetSpacing"></a> | |
| 280 <h4>EricLineEdit.setWidgetSpacing</h4> | |
| 281 <b>setWidgetSpacing</b>(<i>spacing</i>) | |
| 282 | |
| 283 <p> | |
| 284 Public method to set the side widget spacing. | |
| 285 </p> | |
| 286 <dl> | |
| 287 | |
| 288 <dt><i>spacing</i></dt> | |
| 289 <dd> | |
| 290 side widget spacing (integer) | |
| 291 </dd> | |
| 292 </dl> | |
| 293 <a NAME="EricLineEdit.textMargin" ID="EricLineEdit.textMargin"></a> | |
| 294 <h4>EricLineEdit.textMargin</h4> | |
| 295 <b>textMargin</b>(<i>position</i>) | |
| 296 | |
| 297 <p> | |
| 298 Public method to get the text margin for a side. | |
| 299 </p> | |
| 300 <dl> | |
| 301 | |
| 302 <dt><i>position</i> (EricLineEditSide)</dt> | |
| 303 <dd> | |
| 304 side to get margin for | |
| 305 </dd> | |
| 306 </dl> | |
| 307 <dl> | |
| 308 <dt>Return:</dt> | |
| 309 <dd> | |
| 310 text margin | |
| 311 </dd> | |
| 312 </dl> | |
| 313 <dl> | |
| 314 <dt>Return Type:</dt> | |
| 315 <dd> | |
| 316 int | |
| 317 </dd> | |
| 318 </dl> | |
| 319 <a NAME="EricLineEdit.widgetSpacing" ID="EricLineEdit.widgetSpacing"></a> | |
| 320 <h4>EricLineEdit.widgetSpacing</h4> | |
| 321 <b>widgetSpacing</b>(<i></i>) | |
| 322 | |
| 323 <p> | |
| 324 Public method to get the side widget spacing. | |
| 325 </p> | |
| 326 <dl> | |
| 327 <dt>Return:</dt> | |
| 328 <dd> | |
| 329 side widget spacing (integer) | |
| 330 </dd> | |
| 331 </dl> | |
| 332 <div align="right"><a href="#top">Up</a></div> | |
| 333 <hr /> | |
| 334 <hr /> | |
| 335 <a NAME="EricLineEditSide" ID="EricLineEditSide"></a> | |
| 336 <h2>EricLineEditSide</h2> | |
| 337 | |
| 338 <p> | |
| 339 Class defining the line edit sides. | |
| 340 </p> | |
| 341 <h3>Derived from</h3> | |
| 342 enum.Enum | |
| 343 <h3>Class Attributes</h3> | |
| 344 | |
| 345 <table> | |
| 346 <tr><td>LEFT</td></tr><tr><td>RIGHT</td></tr> | |
| 347 </table> | |
| 348 <h3>Class Methods</h3> | |
| 349 | |
| 350 <table> | |
| 351 <tr><td>None</td></tr> | |
| 352 </table> | |
| 353 <h3>Methods</h3> | |
| 354 | |
| 355 <table> | |
| 356 <tr><td>None</td></tr> | |
| 357 </table> | |
| 358 <h3>Static Methods</h3> | |
| 359 | |
| 360 <table> | |
| 361 <tr><td>None</td></tr> | |
| 362 </table> | |
| 363 | |
| 364 <div align="right"><a href="#top">Up</a></div> | |
| 365 <hr /> | |
| 366 <hr /> | |
| 367 <a NAME="EricLineEditSideWidget" ID="EricLineEditSideWidget"></a> | |
| 368 <h2>EricLineEditSideWidget</h2> | |
| 369 | |
| 370 <p> | |
| 371 Class implementing the side widgets for the line edit class. | |
| 372 </p> | |
| 373 <h3>Signals</h3> | |
| 374 <dl> | |
| 375 | |
| 376 <dt>sizeHintChanged()</dt> | |
| 377 <dd> | |
| 378 emitted to indicate a change of the size hint | |
| 379 </dd> | |
| 380 </dl> | |
| 381 <h3>Derived from</h3> | |
| 382 QWidget | |
| 383 <h3>Class Attributes</h3> | |
| 384 | |
| 385 <table> | |
| 386 <tr><td>None</td></tr> | |
| 387 </table> | |
| 388 <h3>Class Methods</h3> | |
| 389 | |
| 390 <table> | |
| 391 <tr><td>None</td></tr> | |
| 392 </table> | |
| 393 <h3>Methods</h3> | |
| 394 | |
| 395 <table> | |
| 396 | |
| 397 <tr> | |
| 398 <td><a href="#EricLineEditSideWidget.__init__">EricLineEditSideWidget</a></td> | |
| 399 <td>Constructor</td> | |
| 400 </tr> | |
| 401 <tr> | |
| 402 <td><a href="#EricLineEditSideWidget.event">event</a></td> | |
| 403 <td>Public method to handle events.</td> | |
| 404 </tr> | |
| 405 </table> | |
| 406 <h3>Static Methods</h3> | |
| 407 | |
| 408 <table> | |
| 409 <tr><td>None</td></tr> | |
| 410 </table> | |
| 411 | |
| 412 <a NAME="EricLineEditSideWidget.__init__" ID="EricLineEditSideWidget.__init__"></a> | |
| 413 <h4>EricLineEditSideWidget (Constructor)</h4> | |
| 414 <b>EricLineEditSideWidget</b>(<i>parent=None</i>) | |
| 415 | |
| 416 <p> | |
| 417 Constructor | |
| 418 </p> | |
| 419 <dl> | |
| 420 | |
| 421 <dt><i>parent</i></dt> | |
| 422 <dd> | |
| 423 reference to the parent widget (QWidget) | |
| 424 </dd> | |
| 425 </dl> | |
| 426 <a NAME="EricLineEditSideWidget.event" ID="EricLineEditSideWidget.event"></a> | |
| 427 <h4>EricLineEditSideWidget.event</h4> | |
| 428 <b>event</b>(<i>evt</i>) | |
| 429 | |
| 430 <p> | |
| 431 Public method to handle events. | |
| 432 </p> | |
| 433 <dl> | |
| 434 | |
| 435 <dt><i>evt</i></dt> | |
| 436 <dd> | |
| 437 reference to the event (QEvent) | |
| 438 </dd> | |
| 439 </dl> | |
| 440 <dl> | |
| 441 <dt>Return:</dt> | |
| 442 <dd> | |
| 443 flag indicating, whether the event was recognized (boolean) | |
| 444 </dd> | |
| 445 </dl> | |
| 446 <div align="right"><a href="#top">Up</a></div> | |
| 447 <hr /> | |
| 448 </body></html> |
