KTextWidgets 5.109.0
|
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< Options > | SearchOptions |
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 . | |
A generic implementation of the "find" function.
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:
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();
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.
typedef QFlags< Options > KFind::SearchOptions |
Stores a combination of #Options values.
enum KFind::Options |
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::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.
void KFind::closeFindNextDialog | ( | ) |
|
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.
|
virtual |
Displays the final dialog saying "no match was found", if that was the case.
Call either this or shouldRestart().
Reimplemented in KReplace.
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.
|
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).
text | The string to search in |
pattern | The pattern to search for |
index | The index in text from which to start the search |
options | The options to use |
matchedlength | If there is a match, its length will be stored in this parameter |
rmatch | If 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 |
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.
int KFind::index | ( | ) | const |
bool KFind::needData | ( | ) | const |
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).
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.
|
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.
QString KFind::pattern | ( | ) | const |
|
virtual |
void KFind::setData | ( | const QString & | data, |
int | startPos = -1 |
||
) |
Call this when needData returns true, before calling find().
data | the text fragment (line) |
startPos | 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. |
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.
id | the id of the text fragment |
data | the text fragment (line) |
startPos | 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. |
|
virtual |
Set new options.
Usually this is used for setting or clearing the FindBackwards options.
void KFind::setPattern | ( | const QString & | pattern | ) |
Change the pattern we're looking for.
|
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).
forceAsking | set to true if the user modified the document during the search. In that case it makes sense to restart the search again. |
showNumMatches | 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). |
Reimplemented in KReplace.
|
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.
|
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.
|
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.
text | The current text fragment |
index | The starting index where the candidate match was found |
matchedlength | The length of the candidate match |