KTextWidgets 5.109.0
|
A generic implementation of the "replace" function. More...
#include <KReplace>
Signals | |
void | textReplaced (const QString &text, int replacementIndex, int replacedLength, int matchedLength) |
Connect to this signal to implement updating of replaced text during the replace operation. | |
![]() | |
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 | |
KReplace (const QString &pattern, const QString &replacement, long options, QWidget *parent, QWidget *replaceDialog) | |
This is the recommended constructor if you also use KReplaceDialog (non-modal). | |
KReplace (const QString &pattern, const QString &replacement, long options, QWidget *parent=nullptr) | |
Only use this constructor if you don't use KFindDialog, or if you use it as a modal dialog. | |
void | closeReplaceNextDialog () |
Close the "replace next?" dialog. | |
void | displayFinalDialog () const override |
Displays the final dialog telling the user how many replacements were made. | |
int | numReplacements () const |
Return the number of replacements made (i.e. | |
Result | replace () |
Walk the text fragment (e.g. | |
QDialog * | replaceNextDialog (bool create=false) |
Return (or create) the dialog that shows the "find next?" prompt. | |
void | resetCounts () override |
Call this to reset the numMatches & numReplacements counts. | |
bool | shouldRestart (bool forceAsking=false, bool showNumMatches=true) const override |
Returns true if we should restart the search from scratch. | |
![]() | |
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 | replace (QString &text, const QString &pattern, const QString &replacement, int index, long options, int *replacedLength) |
Searches the given text for pattern ; if a match is found it is replaced with replacement and the index of the replacement string is returned. | |
![]() | |
static int | find (const QString &text, const QString &pattern, int index, long options, int *matchedLength, QRegularExpressionMatch *rmatch) |
Search text for pattern . | |
Additional Inherited Members | |
![]() | |
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. | |
![]() | |
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 |
A generic implementation of the "replace" 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 replace feature:
In the slot connect to the replace action, after using KReplaceDialog:
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 slotReplaceNext();
Don't forget delete m_find in the destructor of your class, unless you gave it a parent widget on construction.
KReplace::KReplace | ( | const QString & | pattern, |
const QString & | replacement, | ||
long | options, | ||
QWidget * | parent = nullptr |
||
) |
Only use this constructor if you don't use KFindDialog, or if you use it as a modal dialog.
KReplace::KReplace | ( | const QString & | pattern, |
const QString & | replacement, | ||
long | options, | ||
QWidget * | parent, | ||
QWidget * | replaceDialog | ||
) |
This is the recommended constructor if you also use KReplaceDialog (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, KReplace will notice if the find dialog is closed.
void KReplace::closeReplaceNextDialog | ( | ) |
Close the "replace next?" dialog.
The application should do this when the last match was hit. If the application deletes the KReplace, then "find previous" won't be possible anymore.
|
overridevirtual |
Displays the final dialog telling the user how many replacements were made.
Call either this or shouldRestart().
Reimplemented from KFind.
int KReplace::numReplacements | ( | ) | const |
Return the number of replacements made (i.e.
the number of times the textReplaced() signal was emitted).
Can be used in a dialog box to tell the user how many replacements were made. The final dialog does so already, unless you used setDisplayFinalDialog(false).
Result KReplace::replace | ( | ) |
Walk the text fragment (e.g.
kwrite line, kspread cell) looking for matches. For each match, if prompt-on-replace is specified, emits the textFound() signal and displays the prompt-for-replace dialog before doing the replace.
|
static |
Searches the given text
for pattern
; if a match is found it is replaced with replacement
and the index of the replacement string is returned.
text | The string to search |
pattern | The pattern to search for |
replacement | The replacement string to insert into the text |
index | The starting index into the string |
options | The options to use |
replacedLength | Output parameter, contains the length of the replaced string Not always the same as replacement.length(), when backreferences are used |
QDialog * KReplace::replaceNextDialog | ( | 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.
|
overridevirtual |
|
overridevirtual |
Returns true if we should restart the search from scratch.
Can ask the user, or return false (if we already searched/replaced the whole document without the PromptOnReplace option).
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 from KFind.
|
signal |
Connect to this signal to implement updating of replaced text during the replace operation.
Extra care must be taken to properly implement the "no prompt-on-replace" case. For instance, the textFound() signal isn't emitted in that case (some code might rely on it), and for performance reasons one should repaint after replace() ONLY if prompt-on-replace was selected.
text | The text, in which the replacement has already been done |
replacementIndex | Starting index of the matched substring |
replacedLength | Length of the replacement string |
matchedLength | Length of the matched string |