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
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
|
<?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>KFind</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"> </div>
<h1>KFind Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: QObject<br />
Subclasses: <a href="../kdeui/KReplace.html">KReplace</a><br />
<h2>Detailed Description</h2>
<p>A generic implementation of the "find" function.
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> S.R.Haque <srhaque@iee.org>, David Faure <faure@kde.org>, </dd></dl>
Arend van Beelen jr. <arend@auton.nl>
</p>
<p>
<b>Detail:</b>
</p>
<p>
This class includes prompt handling etc. Also provides some
static functions which can be used to create custom behavior
instead of using the class directly.
</p>
<p>
<b>Example:</b>
</p>
<p>
To use the class to implement a complete find feature:
</p>
<p>
In the slot connected to the find action, after using KFindDialog:
<pre class="fragment">
// This creates a find-next-prompt dialog if needed.
m_find = new KFind(pattern, options, this);
// Connect highlight signal to code which handles highlighting
// of found text.
connect( m_find, SIGNAL( highlight( const QString &, int, int ) ),
this, SLOT( slotHighlight( const QString &, int, int ) ) );
// Connect findNext signal - called when pressing the button in the dialog
connect( m_find, SIGNAL( findNext() ),
this, SLOT( slotFindNext() ) );
</pre>
</p>
<p>
If you are using a non-modal find dialog (the recommended new way
in KDE-3.2), you should call right away m_find->closeFindNextDialog().
</p>
<p>
Then initialize the variables determining the "current position"
(to the cursor, if the option FromCursor is set,
to the beginning of the selection if the option SelectedText is set,
and to the beginning of the document otherwise).
Initialize the "end of search" variables as well (end of doc or end of selection).
Swap begin and end if FindBackwards.
Finally, call slotFindNext();
</p>
<p>
<pre class="fragment">
void slotFindNext()
{
KFind.Result res = KFind.NoMatch;
while ( res == KFind.NoMatch && <position not at end> ) {
if ( m_find->needData() )
m_find->setData( <current text fragment> );
// Let KFind inspect the text fragment, and display a dialog if a match is found
res = m_find->find();
if ( res == KFind.NoMatch ) {
<Move to the next text fragment, honoring the FindBackwards setting for the direction>
}
}
if ( res == KFind.NoMatch ) // i.e. at end
<Call either m_find->displayFinalDialog(); m_find->deleteLater(); m_find = 0L;
or if ( m_find->shouldRestart() ) { reinit (w/o FromCursor) and call slotFindNext(); }
else { m_find->closeFindNextDialog(); }>
}
</pre>
</p>
<p>
Don't forget to delete m_find in the destructor of your class,
unless you gave it a parent widget on construction.
</p>
<p>
This implementation allows to have a "Find Next" action, which resumes the
search, even if the user closed the "Find Next" dialog.
</p>
<p>
A "Find Previous" action can simply switch temporarily the value of
FindBackwards and call slotFindNext() - and reset the value afterwards.
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Options">Options</a> </td><td class="memItemRight" valign="bottom">{ WholeWordsOnly, FromCursor, SelectedText, CaseSensitive, FindBackwards, RegularExpression, FindIncremental, MinimumUserOption }</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#Result">Result</a> </td><td class="memItemRight" valign="bottom">{ NoMatch, Match }</td></tr>
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dialogClosed">dialogClosed</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#findNext">findNext</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#highlight">highlight</a> (QString text, int matchingIndex, int matchedLength)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#highlight">highlight</a> (int id, int matchingIndex, int matchedLength)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#optionsChanged">optionsChanged</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KFind">__init__</a> (self, QString pattern, long options, QWidget parent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KFind">__init__</a> (self, QString pattern, long options, QWidget parent, QWidget findDialog)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#closeFindNextDialog">closeFindNextDialog</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget </td><td class="memItemRight" valign="bottom"><a class="el" href="#dialogsParent">dialogsParent</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#displayFinalDialog">displayFinalDialog</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KFind.html#Result">KFind.Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#find">find</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KDialog.html">KDialog</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#findNextDialog">findNextDialog</a> (self, bool create=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#index">index</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#needData">needData</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#numMatches">numMatches</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#options">options</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget </td><td class="memItemRight" valign="bottom"><a class="el" href="#parentWidget">parentWidget</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#pattern">pattern</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resetCounts">resetCounts</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setData">setData</a> (self, QString data, int startPos=-1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setData">setData</a> (self, int id, QString data, int startPos=-1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setOptions">setOptions</a> (self, long options)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPattern">setPattern</a> (self, QString pattern)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#shouldRestart">shouldRestart</a> (self, bool forceAsking=0, bool showNumMatches=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#validateMatch">validateMatch</a> (self, QString text, int index, int matchedlength)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, int matchedlength </td><td class="memItemRight" valign="bottom"><a class="el" href="#find">find</a> (QString text, QString pattern, int index, long options)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, int matchedlength </td><td class="memItemRight" valign="bottom"><a class="el" href="#find">find</a> (QString text, QRegExp pattern, int index, long options)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="dialogClosed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> dialogClosed</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emitted when the 'find next' dialog is being closed.
Some apps might want to remove the highlighted text when this happens.
Apps without support for "Find Next" can also do m_find->deleteLater()
to terminate the find operation.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("dialogClosed()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="findNext"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> findNext</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("findNext()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="highlight"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> highlight</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>matchingIndex</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>matchedLength</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Connect to this signal to implement highlighting of found text during the find
operation.
</p>
<p>
Use this signal if you've set your data with setData(id, text), otherwise
use the signal with highlight(text, matchingIndex, matchedLength).
</p>
<p>
WARNING: If you're using the FindIncremental option, the id argument
passed by this signal is not necessarily the id of the data last set
through setData(), but can also be of an earlier set data block.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setData()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("highlight(const QString&, int, int)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="highlight"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> highlight</td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>matchingIndex</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>matchedLength</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Connect to this signal to implement highlighting of found text during the find
operation.
</p>
<p>
Use this signal if you've set your data with setData(id, text), otherwise
use the signal with highlight(text, matchingIndex, matchedLength).
</p>
<p>
WARNING: If you're using the FindIncremental option, the id argument
passed by this signal is not necessarily the id of the data last set
through setData(), but can also be of an earlier set data block.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> setData()
</dd></dl>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("highlight(int, int, int)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="optionsChanged"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> optionsChanged</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname">)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Emitted when the options have changed.
This can happen e.g. with "Replace All", or if our 'find next' dialog
gets a "find previous" one day.
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("optionsChanged()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KFind"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Only use this constructor if you don't use KFindDialog, or if
you use it as a modal dialog.
</p></div></div><a class="anchor" name="KFind"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>findDialog</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 the recommended constructor if you also use KFindDialog (non-modal).
You should pass the pointer to it here, so that when a message box
appears it has the right parent. Don't worry about deletion, KFind
will notice if the find dialog is closed.
</p></div></div><a class="anchor" name="closeFindNextDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> closeFindNextDialog</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Close the "find next?" dialog. The application should do this when
the last match was hit. If the application deletes the KFind, then
"find previous" won't be possible anymore.
</p>
<p>
IMPORTANT: you should also call this if you are using a non-modal
find dialog, to tell KFind not to pop up its own dialog.
</p></div></div><a class="anchor" name="dialogsParent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QWidget dialogsParent</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="displayFinalDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> displayFinalDialog</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Displays the final dialog saying "no match was found", if that was the case.
Call either this or shouldRestart().
</p></div></div><a class="anchor" name="find"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KFind.html#Result">KFind.Result</a> find</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Search the given string, and returns whether a match was found. If one is,
the length of the string matched is also returned.
</p>
<p>
A performance optimised version of the function is provided for use
with regular expressions.
</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>text</em> </td><td> The string to search.
<tr><td></td><td valign="top"><em>pattern</em> </td><td> The pattern to look for.
<tr><td></td><td valign="top"><em>index</em> </td><td> The starting index into the string.
<tr><td></td><td valign="top"><em>options</em> </td><td> The options to use.
<tr><td></td><td valign="top"><em>matchedlength</em> </td><td> The length of the string that was matched
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> The index at which a match was found, or -1 if no match was found.
</dd></dl>
</p></div></div><a class="anchor" name="findNextDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KDialog.html">KDialog</a> findNextDialog</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>create=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Return (or create) the dialog that shows the "find next?" prompt.
Usually you don't need to call this.
One case where it can be useful, is when the user selects the "Find"
menu item while a find operation is under way. In that case, the
program may want to call setActiveWindow() on that dialog.
</p></div></div><a class="anchor" name="index"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int index</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the current matching index ( or -1 ).
Same as the matchingIndex parameter passed to highlight.
You usually don't need to use this, except maybe when updating the current data,
so you need to call setData( newData, index() ).
</dd></dl>
</p></div></div><a class="anchor" name="needData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool needData</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the application must supply a new text fragment
It also means the last call returned "NoMatch". But by storing this here
the application doesn't have to store it in a member variable (between
calls to slotFindNext()).
</dd></dl>
</p></div></div><a class="anchor" name="numMatches"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int numMatches</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Return the number of matches found (i.e. the number of times
the highlight signal was emitted).
If 0, can be used in a dialog box to tell the user "no match was found".
The final dialog does so already, unless you used setDisplayFinalDialog(false).
</p></div></div><a class="anchor" name="options"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long options</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Return the current options.
</p>
<p>
Warning: this is usually the same value as the one passed to the constructor,
but options might change _during_ the replace operation:
e.g. the "All" button resets the PromptOnReplace flag.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KFind.Options
</dd></dl>
</p></div></div><a class="anchor" name="parentWidget"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QWidget parentWidget</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="pattern"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString pattern</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the pattern we're currently looking for
</dd></dl>
</p></div></div><a class="anchor" name="resetCounts"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> resetCounts</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Call this to reset the numMatches count
(and the numReplacements count for a KReplace).
Can be useful if reusing the same KReplace for different operations,
or when restarting from the beginning of the document.
</p></div></div><a class="anchor" name="setData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setData</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>startPos=-1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this when needData returns true, before calling find(). The use of
ID's is especially useful if you're using the FindIncremental option.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>id</em> </td><td> the id of the text fragment
<tr><td></td><td valign="top"><em>data</em> </td><td> the text fragment (line)
<tr><td></td><td valign="top"><em>startPos</em> </td><td> if set, the index at which the search should start.
This is only necessary for the very first call to setData usually,
for the 'find in selection' feature. A value of -1 (the default value)
means "process all the data", i.e. either 0 or data.length()-1 depending
on FindBackwards.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setData</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>id</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>startPos=-1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this when needData returns true, before calling find(). The use of
ID's is especially useful if you're using the FindIncremental option.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>id</em> </td><td> the id of the text fragment
<tr><td></td><td valign="top"><em>data</em> </td><td> the text fragment (line)
<tr><td></td><td valign="top"><em>startPos</em> </td><td> if set, the index at which the search should start.
This is only necessary for the very first call to setData usually,
for the 'find in selection' feature. A value of -1 (the default value)
means "process all the data", i.e. either 0 or data.length()-1 depending
on FindBackwards.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setOptions"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setOptions</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>options</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set new options. Usually this is used for setting or clearing the
FindBackwards options.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KFind.Options
</dd></dl>
</p></div></div><a class="anchor" name="setPattern"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setPattern</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>pattern</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Change the pattern we're looking for
</p></div></div><a class="anchor" name="shouldRestart"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool shouldRestart</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>forceAsking=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>showNumMatches=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Returns true if we should restart the search from scratch.
Can ask the user, or return false (if we already searched the whole document).
</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>forceAsking</em> </td><td> set to true if the user modified the document during the
search. In that case it makes sense to restart the search again.
</td></tr>
<tr><td></td><td valign="top"><em>showNumMatches</em> </td><td> set to true if the dialog should show the number of
matches. Set to false if the application provides a "find previous" action,
in which case the match count will be erroneous when hitting the end,
and we could even be hitting the beginning of the document (so not all
matches have even been seen).
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="validateMatch"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool validateMatch</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>matchedlength</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Virtual method, which allows applications to add extra checks for
validating a candidate match. It's only necessary to reimplement this
if the find dialog extension has been used to provide additional
criterias.
</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>text</em> </td><td> The current text fragment
<tr><td></td><td valign="top"><em>index</em> </td><td> The starting index where the candidate match was found
<tr><td></td><td valign="top"><em>matchedlength</em> </td><td> The length of the candidate match
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="find"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, int matchedlength find</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>options</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Search the given string, and returns whether a match was found. If one is,
the length of the string matched is also returned.
</p>
<p>
A performance optimised version of the function is provided for use
with regular expressions.
</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>text</em> </td><td> The string to search.
<tr><td></td><td valign="top"><em>pattern</em> </td><td> The pattern to look for.
<tr><td></td><td valign="top"><em>index</em> </td><td> The starting index into the string.
<tr><td></td><td valign="top"><em>options</em> </td><td> The options to use.
<tr><td></td><td valign="top"><em>matchedlength</em> </td><td> The length of the string that was matched
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> The index at which a match was found, or -1 if no match was found.
</dd></dl>
</p></div></div><a class="anchor" name="find"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, int matchedlength find</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QRegExp </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>options</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Search the given string, and returns whether a match was found. If one is,
the length of the string matched is also returned.
</p>
<p>
A performance optimised version of the function is provided for use
with regular expressions.
</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>text</em> </td><td> The string to search.
<tr><td></td><td valign="top"><em>pattern</em> </td><td> The pattern to look for.
<tr><td></td><td valign="top"><em>index</em> </td><td> The starting index into the string.
<tr><td></td><td valign="top"><em>options</em> </td><td> The options to use.
<tr><td></td><td valign="top"><em>matchedlength</em> </td><td> The length of the string that was matched
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> The index at which a match was found, or -1 if no match was found.
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Options"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Options</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>PromptOnReplace</em> = 256</td><td><tr><td valign="top"><em>BackReference</em> = 512</td><td></table>
</dl>
</div></div><p><a class="anchor" name="Result"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Result</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>NoMatch</em> </td><td><tr><td valign="top"><em>Match</em> </td><td></table>
</dl>
</div></div><p>
</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="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</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>
|
