KTextWidgets 5.109.0
Public Types | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
KFind

A generic implementation of the "find" function. More...

#include <KFind>

Public Types

enum  Options {
  WholeWordsOnly = 1 , FromCursor = 2 , SelectedText = 4 , CaseSensitive = 8 ,
  FindBackwards = 16 , RegularExpression = 32 , FindIncremental = 64 , MinimumUserOption = 65536
}
 
enum  Result { NoMatch , Match }
 
typedef QFlags< OptionsSearchOptions
 Stores a combination of #Options values.
 

Signals

void dialogClosed ()
 Emitted when the 'find next' dialog is being closed.
 
void findNext ()
 
void optionsChanged ()
 Emitted when the options have changed.
 
void textFound (const QString &text, int matchingIndex, int matchedLength)
 Connect to this signal to implement highlighting of found text during the find operation.
 
void textFoundAtId (int id, int matchingIndex, int matchedLength)
 Connect to this signal to implement highlighting of found text during the find operation.
 

Public Member Functions

 KFind (const QString &pattern, long options, QWidget *parent)
 Only use this constructor if you don't use KFindDialog, or if you use it as a modal dialog.
 
 KFind (const QString &pattern, long options, QWidget *parent, QWidget *findDialog)
 This is the recommended constructor if you also use KFindDialog (non-modal).
 
void closeFindNextDialog ()
 Close the "find next?" dialog.
 
virtual void displayFinalDialog () const
 Displays the final dialog saying "no match was found", if that was the case.
 
Result find ()
 Walk the text fragment (e.g.
 
QDialog * findNextDialog (bool create=false)
 Return (or create) the dialog that shows the "find next?" prompt.
 
int index () const
 
bool needData () const
 
int numMatches () const
 Returns the number of matches found (i.e.
 
long options () const
 Return the current options.
 
QString pattern () const
 
virtual void resetCounts ()
 Call this to reset the numMatches count (and the numReplacements count for a KReplace).
 
void setData (const QString &data, int startPos=-1)
 Call this when needData returns true, before calling find().
 
void setData (int id, const QString &data, int startPos=-1)
 Call this when needData returns true, before calling find().
 
virtual void setOptions (long options)
 Set new options.
 
void setPattern (const QString &pattern)
 Change the pattern we're looking for.
 
virtual bool shouldRestart (bool forceAsking=false, bool showNumMatches=true) const
 Returns true if we should restart the search from scratch.
 
virtual bool validateMatch (const QString &text, int index, int matchedlength)
 Virtual method, which allows applications to add extra checks for validating a candidate match.
 

Static Public Member Functions

static int find (const QString &text, const QString &pattern, int index, long options, int *matchedLength, QRegularExpressionMatch *rmatch)
 Search text for pattern.
 

Protected Member Functions

KTEXTWIDGETS_NO_EXPORT KFind (KFindPrivate &dd, const QString &pattern, long options, QWidget *parent)
 
KTEXTWIDGETS_NO_EXPORT KFind (KFindPrivate &dd, const QString &pattern, long options, QWidget *parent, QWidget *findDialog)
 
QWidget * dialogsParent () const
 
QWidget * parentWidget () const
 

Detailed Description

A generic implementation of the "find" function.

Author
S.R.Haque srhaq.nosp@m.ue@i.nosp@m.ee.or.nosp@m.g, David Faure faure.nosp@m.@kde.nosp@m..org, Arend van Beelen jr. arend.nosp@m.@aut.nosp@m.on.nl

Detail:

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.

Example:

To use the class to implement a complete find feature:

In the slot connected to the find action, after using KFindDialog:

// This creates a find-next-prompt dialog if needed.
m_find = new KFind(pattern, options, this);
// Connect textFound() signal to code which handles highlighting of found text.
connect(m_find, &KFind::textFound, this, [this](const QString &text, int matchingIndex, int matchedLength) {
slotHighlight(text, matchingIndex, matchedLength);
}));
// Connect findNext signal - called when pressing the button in the dialog
connect(m_find, SIGNAL(findNext()),
this, SLOT(slotFindNext()));
A generic implementation of the "find" function.
Definition kfind.h:94
void textFound(const QString &text, int matchingIndex, int matchedLength)
Connect to this signal to implement highlighting of found text during the find operation.

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();

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 = nullptr;
or if (m_find->shouldRestart()) { reinit (w/o FromCursor); m_find->resetCounts(); slotFindNext(); }
else { m_find->closeFindNextDialog(); }>
}
@ FindBackwards
Go backwards.
Definition kfind.h:106

Don't forget to delete m_find in the destructor of your class, unless you gave it a parent widget on construction.

This implementation allows to have a "Find Next" action, which resumes the search, even if the user closed the "Find Next" dialog.

A "Find Previous" action can simply switch temporarily the value of FindBackwards and call slotFindNext() - and reset the value afterwards.

Member Typedef Documentation

◆ SearchOptions

typedef QFlags< Options > KFind::SearchOptions

Stores a combination of #Options values.

Member Enumeration Documentation

◆ Options

See also
SearchOptions
Enumerator
WholeWordsOnly 

Match whole words only.

FromCursor 

Start from current cursor position.

SelectedText 

Only search selected area.

CaseSensitive 

Consider case when matching.

FindBackwards 

Go backwards.

RegularExpression 

Interpret the pattern as a regular expression.

FindIncremental 

Find incremental.

MinimumUserOption 

user options start with this bit

Constructor & Destructor Documentation

◆ KFind() [1/2]

KFind::KFind ( const QString &  pattern,
long  options,
QWidget *  parent 
)

Only use this constructor if you don't use KFindDialog, or if you use it as a modal dialog.

◆ KFind() [2/2]

KFind::KFind ( const QString &  pattern,
long  options,
QWidget *  parent,
QWidget *  findDialog 
)

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.

Member Function Documentation

◆ closeFindNextDialog()

void KFind::closeFindNextDialog ( )

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.

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.

◆ dialogClosed

void KFind::dialogClosed ( )
signal

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.

◆ displayFinalDialog()

virtual void KFind::displayFinalDialog ( ) const
virtual

Displays the final dialog saying "no match was found", if that was the case.

Call either this or shouldRestart().

Reimplemented in KReplace.

◆ find() [1/2]

Result KFind::find ( )

Walk the text fragment (e.g.

in a text-processor line or spreadsheet cell ...etc) looking for matches. For each match, emits the textFound() signal and displays the find-again dialog to ask if the user wants to find the same text again.

◆ find() [2/2]

static int KFind::find ( const QString &  text,
const QString &  pattern,
int  index,
long  options,
int *  matchedLength,
QRegularExpressionMatch *  rmatch 
)
static

Search text for pattern.

If a match is found, the length of the matched string will be stored in matchedLength and the index of the matched string will be returned. If no match is found -1 is returned.

If the KFind::RegularExpression flag is set, the pattern will be iterpreted as a regular expression (using QRegularExpression).

Note
Unicode support is always enabled (by setting the QRegularExpression::UseUnicodePropertiesOption flag).
Parameters
textThe string to search in
patternThe pattern to search for
indexThe index in text from which to start the search
optionsThe options to use
matchedlengthIf there is a match, its length will be stored in this parameter
rmatchIf there is a regular expression match (implies that the KFind::RegularExpression flag is set) and rmatch is not a nullptr the match result will be stored in this QRegularExpressionMatch object
Returns
The index at which a match was found otherwise -1
Since
5.70

◆ findNextDialog()

QDialog * KFind::findNextDialog ( bool  create = false)

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.

◆ index()

int KFind::index ( ) const
Returns
the current matching index (or -1). Same as the matchingIndex parameter passed to the textFound() signal. You usually don't need to use this, except maybe when updating the current data, so you need to call setData(newData, index()).

◆ needData()

bool KFind::needData ( ) const
Returns
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()).

◆ numMatches()

int KFind::numMatches ( ) const

Returns the number of matches found (i.e.

the number of times the textFound() 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).

◆ options()

long KFind::options ( ) const

Return the current options.

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.

See also
KFind::Options

◆ optionsChanged

void KFind::optionsChanged ( )
signal

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.

◆ pattern()

QString KFind::pattern ( ) const
Returns
the pattern we're currently looking for

◆ resetCounts()

virtual void KFind::resetCounts ( )
virtual

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.

Reimplemented in KReplace.

◆ setData() [1/2]

void KFind::setData ( const QString &  data,
int  startPos = -1 
)

Call this when needData returns true, before calling find().

Parameters
datathe text fragment (line)
startPosif 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.

◆ setData() [2/2]

void KFind::setData ( int  id,
const QString &  data,
int  startPos = -1 
)

Call this when needData returns true, before calling find().

The use of ID's is especially useful if you're using the FindIncremental option.

Parameters
idthe id of the text fragment
datathe text fragment (line)
startPosif 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.

◆ setOptions()

virtual void KFind::setOptions ( long  options)
virtual

Set new options.

Usually this is used for setting or clearing the FindBackwards options.

See also
KFind::Options

◆ setPattern()

void KFind::setPattern ( const QString &  pattern)

Change the pattern we're looking for.

◆ shouldRestart()

virtual bool KFind::shouldRestart ( bool  forceAsking = false,
bool  showNumMatches = true 
) const
virtual

Returns true if we should restart the search from scratch.

Can ask the user, or return false (if we already searched the whole document).

Parameters
forceAskingset to true if the user modified the document during the search. In that case it makes sense to restart the search again.
showNumMatchesset 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).

Reimplemented in KReplace.

◆ textFound

void KFind::textFound ( const QString &  text,
int  matchingIndex,
int  matchedLength 
)
signal

Connect to this signal to implement highlighting of found text during the find operation.

If you've set data with setData(id, text), use the textFoundAtId(int, int, int) signal.

WARNING: If you're using the FindIncremental option, the text argument passed by this signal is not necessarily the data last set through setData(), but can also be an earlier set data block.

See also
setData()
Since
5.81

◆ textFoundAtId

void KFind::textFoundAtId ( int  id,
int  matchingIndex,
int  matchedLength 
)
signal

Connect to this signal to implement highlighting of found text during the find operation.

Use this signal if you've set your data with setData(id, text), otherwise use the textFound(text, matchingIndex, matchedLength) signal.

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.

See also
setData()
Since
5.81

◆ validateMatch()

virtual bool KFind::validateMatch ( const QString &  text,
int  index,
int  matchedlength 
)
virtual

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 criteria.

Parameters
textThe current text fragment
indexThe starting index where the candidate match was found
matchedlengthThe length of the candidate match