File: KInputDialog.html

package info (click to toggle)
pykde4 4%3A4.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 30,864 kB
  • ctags: 18,431
  • sloc: python: 2,063; cpp: 327; makefile: 52; sh: 5
file content (683 lines) | stat: -rw-r--r-- 22,200 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">

<head>
  <title>KInputDialog</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta http-equiv="Content-Style-Type" content="text/css" />
  <link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
  <link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
  <div id="header_top">
    <div>
      <div>
        <img alt ="" src="../common/top-kde.jpg"/>
        KDE 4.9 PyKDE API Reference
      </div>
    </div>
  </div>
  <div id="header_bottom">
    <div id="location">
      <ul>
        <li>KDE's Python API</li>
      </ul>
    </div>

    <div id="menu">
      <ul>
        <li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
    </div>
  </div>
</div>

<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer">&nbsp;</div>

<h1>KInputDialog Namespace Reference</h1>
<code>from PyKDE4.kdeui.KInputDialog import *</code>
<p>
<h2>Detailed Description</h2>
<p>The KInputDialog namespace provides simple dialogs to get a single value
from the user. The value can be a string, a number (either an integer or
a float) or an item from a list.
</p>
<p>

<dl class="author" compact><dt><b>Author:</b></dt><dd> Nadeem Hasan &lt;nhasan@kde.org&gt; </dd></dl>
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float, bool ok&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#getDouble">getDouble</a> (QString caption, QString label, float value=0, float minValue=-DBL_MAX, float maxValue=DBL_MAX, float step=0.1, int decimals=1, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">float&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#getDouble">getDouble</a> (QString caption, QString label, float value=0, float minValue=-DBL_MAX, float maxValue=DBL_MAX, float step=0.1, int decimals=1, bool ok=0, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, bool ok&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#getInteger">getInteger</a> (QString caption, QString label, int value=0, int minValue=INT_MIN, int maxValue=INT_MAX, int step=1, int base=10, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#getInteger">getInteger</a> (QString caption, QString label, int value=0, int minValue=INT_MIN, int maxValue=INT_MAX, int step=1, int base=10, bool ok=0, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString, bool ok&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#getItem">getItem</a> (QString caption, QString label, QStringList list, int current=0, bool editable=0, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList, bool ok&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#getItemList">getItemList</a> (QString caption, QString label, QStringList list=QStringList(), QStringList select=QStringList(), bool multiple=0, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString, bool ok&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#getMultiLineText">getMultiLineText</a> (QString caption, QString label, QString value=QString(), QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString, bool ok&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#getText">getText</a> (QString caption, QString label, QString value=QString(), QWidget parent=0, QValidator validator=0, QString mask=QString(), QString whatsThis=QString(), QStringList completionList=QStringList())</td></tr>
</table>
<hr><h2>Function Documentation</h2><a class="anchor" name="getDouble"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">float, bool ok getDouble</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>caption</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"><em>value=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"><em>minValue=-DBL_MAX</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"><em>maxValue=DBL_MAX</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"><em>step=0.1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>decimals=1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget&nbsp;</td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This is an overloaded convenience function. It behaves exctly like
the above function.
</p></div></div><a class="anchor" name="getDouble"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">float getDouble</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>caption</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"><em>value=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"><em>minValue=-DBL_MAX</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"><em>maxValue=DBL_MAX</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">float&nbsp;</td>
<td class="paramname"><em>step=0.1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>decimals=1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>ok=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget&nbsp;</td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This is an overloaded convenience function. It behaves exctly like
the above function.
</p></div></div><a class="anchor" name="getInteger"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, bool ok getInteger</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>caption</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>value=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>minValue=INT_MIN</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>maxValue=INT_MAX</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>step=1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>base=10</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget&nbsp;</td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This is an overloaded convenience function. It behaves exactly same as
above except it assumes base to be 10, i.e. accepts decimal numbers.
</p></div></div><a class="anchor" name="getInteger"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int getInteger</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>caption</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>value=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>minValue=INT_MIN</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>maxValue=INT_MAX</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>step=1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>base=10</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>ok=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget&nbsp;</td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This is an overloaded convenience function. It behaves exactly same as
above except it assumes base to be 10, i.e. accepts decimal numbers.
</p></div></div><a class="anchor" name="getItem"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString, bool ok getItem</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>caption</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList&nbsp;</td>
<td class="paramname"><em>list</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int&nbsp;</td>
<td class="paramname"><em>current=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>editable=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget&nbsp;</td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Static convenience function to let the user select an item from a
list. caption is the text that is displayed in the title bar.
label is the text that appears as the label for the list. list
is the string list which is inserted into the list, and current
is the number of the item which should be the selected item. If
editable is true, the user can enter his own text.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>caption</em>&nbsp;</td><td> Caption of the dialog

<tr><td></td><td valign="top"><em>label</em>&nbsp;</td><td> Text of the label for the list

<tr><td></td><td valign="top"><em>list</em>&nbsp;</td><td> List of item for user to choose from

<tr><td></td><td valign="top"><em>current</em>&nbsp;</td><td> Index of the selected item

<tr><td></td><td valign="top"><em>editable</em>&nbsp;</td><td> If true, user can enter own text

<tr><td></td><td valign="top"><em>ok</em>&nbsp;</td><td> This bool would be set to true if user pressed Ok

<tr><td></td><td valign="top"><em>parent</em>&nbsp;</td><td> Parent of the dialog widget
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> Text of the selected item. If <b>editable</b> is true this can be
a text entered by the user.
</dd></dl>
</p></div></div><a class="anchor" name="getItemList"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QStringList, bool ok getItemList</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>caption</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList&nbsp;</td>
<td class="paramname"><em>list=QStringList()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList&nbsp;</td>
<td class="paramname"><em>select=QStringList()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool&nbsp;</td>
<td class="paramname"><em>multiple=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget&nbsp;</td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Static convenience function to let the user select one or more
items from a listbox. caption is the text that is displayed in the
title bar. label is the text that appears as the label for the listbox.
list is the string list which is inserted into the listbox, select
is the list of item(s) that should be the selected. If multiple is
true, the user can select multiple items.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>caption</em>&nbsp;</td><td> Caption of the dialog

<tr><td></td><td valign="top"><em>label</em>&nbsp;</td><td> Text of the label for the list

<tr><td></td><td valign="top"><em>list</em>&nbsp;</td><td> List of item for user to choose from

<tr><td></td><td valign="top"><em>select</em>&nbsp;</td><td> List of item(s) that should be selected

<tr><td></td><td valign="top"><em>multiple</em>&nbsp;</td><td> If true, user can select multiple items

<tr><td></td><td valign="top"><em>ok</em>&nbsp;</td><td> This bool would be set to true if user pressed Ok

<tr><td></td><td valign="top"><em>parent</em>&nbsp;</td><td> Parent of the dialog widget
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> List of selected items if multiple is true, else currently
selected item as a QStringList
</dd></dl>
</p></div></div><a class="anchor" name="getMultiLineText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString, bool ok getMultiLineText</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>caption</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>value=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget&nbsp;</td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Static convenience function to get a multiline string from the user.
</p>
<p>
caption is the text that is displayed in the title bar. label is the
text that appears as a label for the line edit. value is the initial
value of the line edit. ok will be set to true if user pressed Ok
and false if user pressed Cancel.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>caption</em>&nbsp;</td><td> Caption of the dialog

<tr><td></td><td valign="top"><em>label</em>&nbsp;</td><td> Text of the label for the line edit

<tr><td></td><td valign="top"><em>value</em>&nbsp;</td><td> Initial value of the line edit

<tr><td></td><td valign="top"><em>ok</em>&nbsp;</td><td> This bool would be set to true if user pressed Ok

<tr><td></td><td valign="top"><em>parent</em>&nbsp;</td><td> Parent of the dialog widget
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> String user entered if Ok was pressed, else a null string
</dd></dl>
</p></div></div><a class="anchor" name="getText"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString, bool ok getText</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>caption</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>label</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>value=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget&nbsp;</td>
<td class="paramname"><em>parent=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QValidator&nbsp;</td>
<td class="paramname"><em>validator=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>mask=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>whatsThis=QString()</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QStringList&nbsp;</td>
<td class="paramname"><em>completionList=QStringList()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Static convenience function to get a string from the user.
</p>
<p>
caption is the text that is displayed in the title bar. label is the
text that appears as a label for the line edit. value is the initial
value of the line edit. ok will be set to true if user pressed Ok
and false if user pressed Cancel.
</p>
<p>
If you provide a validator, the Ok button is disabled as long as
the validator doesn't return Acceptable. If there is no validator,
the Ok button is enabled whenever the line edit isn't empty. If you
want to accept empty input, create a trivial QValidator that
always returns acceptable, e.g. QRegExpValidator with a regexp
of ".*".
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>caption</em>&nbsp;</td><td> Caption of the dialog

<tr><td></td><td valign="top"><em>label</em>&nbsp;</td><td> Text of the label for the line edit

<tr><td></td><td valign="top"><em>value</em>&nbsp;</td><td> Initial value of the line edit

<tr><td></td><td valign="top"><em>ok</em>&nbsp;</td><td> This bool would be set to true if user pressed Ok

<tr><td></td><td valign="top"><em>parent</em>&nbsp;</td><td> Parent of the dialog widget

<tr><td></td><td valign="top"><em>validator</em>&nbsp;</td><td> A QValidator to be associated with the line edit

<tr><td></td><td valign="top"><em>mask</em>&nbsp;</td><td> Mask associated with the line edit. See the
documentation for QLineEdit about masks

<tr><td></td><td valign="top"><em>whatsThis</em>&nbsp;</td><td> a QWhatsThis text for the input widget.

<tr><td></td><td valign="top"><em>completionList</em>&nbsp;</td><td> a list of items which should be used for input completion
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> String user entered if Ok was pressed, else a null string
</dd></dl>
</p></div></div>
</div>
</div>
</div>

<div id="left">

<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>

<a name="cp-menu" /><div class="menutitle"><div>
  <h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>

</div>

</div>
  <div class="clearer"/>
</div>

<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
        <a href="http://www.kde.org/contact/impressum.php">Legal</a>
    </div></div>
</body>
</html>