KTextWidgets 5.109.0
Signals | Public Member Functions | Static Public Member Functions | List of all members
KReplace

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.
 
- Signals inherited from KFind
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.
 
- Public Member Functions inherited from 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 (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 Public Member Functions inherited from KFind
static int find (const QString &text, const QString &pattern, int index, long options, int *matchedLength, QRegularExpressionMatch *rmatch)
 Search text for pattern.
 

Additional Inherited Members

- Public Types inherited from KFind
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.
 
- Protected Member Functions inherited from KFind
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 "replace" 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

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:

// This creates a replace-on-prompt dialog if needed.
m_replace = new KReplace(pattern, replacement, options, this);
// Connect signals to code which handles highlighting of found text, and
// on-the-fly replacement.
connect(m_replace, &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_replace, SIGNAL( findNext() ),
this, SLOT( slotReplaceNext() ) );
// Connect to the textReplaced() signal - emitted when a replacement is done
connect( m_replace, &KReplace::textReplaced, this, [this](const QString &text, int replacementIndex, int replacedLength, int matchedLength) {
slotReplace(text, replacementIndex, replacedLength, matchedLength);
});
void textFound(const QString &text, int matchingIndex, int matchedLength)
Connect to this signal to implement highlighting of found text during the find operation.
A generic implementation of the "replace" function.
Definition kreplace.h:90
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.

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

void slotReplaceNext()
{
KFind::Result res = KFind::NoMatch;
while ( res == KFind::NoMatch && <position not at end> ) {
if ( m_replace->needData() )
m_replace->setData( <current text fragment> );
// Let KReplace inspect the text fragment, and display a dialog if a match is found
res = m_replace->replace();
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_replace->displayFinalDialog(); delete m_replace; m_replace = nullptr;
or if ( m_replace->shouldRestart() ) { reinit (w/o FromCursor) and call slotReplaceNext(); }
else { m_replace->closeReplaceNextDialog(); }>
}
@ FindBackwards
Go backwards.
Definition kfind.h:106

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

Constructor & Destructor Documentation

◆ KReplace() [1/2]

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() [2/2]

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.

Member Function Documentation

◆ closeReplaceNextDialog()

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.

◆ displayFinalDialog()

void KReplace::displayFinalDialog ( ) const
overridevirtual

Displays the final dialog telling the user how many replacements were made.

Call either this or shouldRestart().

Reimplemented from KFind.

◆ numReplacements()

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

◆ replace() [1/2]

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.

◆ replace() [2/2]

static int KReplace::replace ( QString &  text,
const QString &  pattern,
const QString &  replacement,
int  index,
long  options,
int *  replacedLength 
)
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.

Parameters
textThe string to search
patternThe pattern to search for
replacementThe replacement string to insert into the text
indexThe starting index into the string
optionsThe options to use
replacedLengthOutput parameter, contains the length of the replaced string Not always the same as replacement.length(), when backreferences are used
Returns
The index at which a match was found, or -1 otherwise

◆ replaceNextDialog()

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.

◆ resetCounts()

void KReplace::resetCounts ( )
overridevirtual

Call this to reset the numMatches & numReplacements counts.

Can be useful if reusing the same KReplace for different operations, or when restarting from the beginning of the document.

Reimplemented from KFind.

◆ shouldRestart()

bool KReplace::shouldRestart ( bool  forceAsking = false,
bool  showNumMatches = true 
) const
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).

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 from KFind.

◆ textReplaced

void KReplace::textReplaced ( const QString &  text,
int  replacementIndex,
int  replacedLength,
int  matchedLength 
)
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.

Parameters
textThe text, in which the replacement has already been done
replacementIndexStarting index of the matched substring
replacedLengthLength of the replacement string
matchedLengthLength of the matched string
Since
5.83