KReplace

#include <KReplace>

Inheritance diagram for KReplace:

[legend]

Signals
void	textReplaced (const QString &text, int replacementIndex, int replacedLength, int matchedLength)

Signals inherited from KFind
void	dialogClosed ()

void	findNext ()

void	optionsChanged ()

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

void	textFoundAtId (int id, int matchingIndex, int matchedLength)

Public Member Functions
	KReplace (const QString &pattern, const QString &replacement, long options, QWidget parent, QWidget replaceDialog)

	KReplace (const QString &pattern, const QString &replacement, long options, QWidget *parent=nullptr)

void	closeReplaceNextDialog ()

void	displayFinalDialog () const override

int	numReplacements () const

Result	replace ()

QDialog *	replaceNextDialog (bool create=false)

void	resetCounts () override

bool	shouldRestart (bool forceAsking=false, bool showNumMatches=true) const override

Public Member Functions inherited from KFind
	KFind (const QString &pattern, long options, QWidget *parent)

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

void	closeFindNextDialog ()

Result	find ()

QDialog *	findNextDialog (bool create=false)

int	index () const

bool	needData () const

int	numMatches () const

long	options () const

QString	pattern () const

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

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

virtual void	setOptions (long options)

void	setPattern (const QString &pattern)

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

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Static Public Member Functions
static int	replace (QString &text, const QString &pattern, const QString &replacement, int index, long options, int *replacedLength)

Static Public Member Functions inherited from KFind
static int	find (const QString &text, const QString &pattern, int index, long options, int matchedLength, QRegularExpressionMatch rmatch)

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

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< Options >	SearchOptions

Properties inherited from QObject
	objectName

Public Attributes inherited from QObject
typedef	QObjectList

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

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Attributes inherited from KFind
std::unique_ptr< class KFindPrivate > const	d_ptr

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

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

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

Definition at line 89 of file kreplace.h.

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.

Definition at line 121 of file kreplace.cpp.

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

Definition at line 126 of file kreplace.cpp.

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.

Definition at line 403 of file kreplace.cpp.

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

Definition at line 173 of file kreplace.cpp.

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

Definition at line 133 of file kreplace.cpp.

◆ replace() [1/2]

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

Definition at line 206 of file kreplace.cpp.

◆ replace() [2/2]

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

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

Returns: The index at which a match was found, or -1 otherwise

Definition at line 268 of file kreplace.cpp.

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

Definition at line 140 of file kreplace.cpp.

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

Definition at line 355 of file kreplace.cpp.

◆ 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

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.

Definition at line 363 of file kreplace.cpp.

◆ 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

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

Since: 5.83

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KTextWidgets

KReplace

Signals

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KReplace() [1/2]

◆ KReplace() [2/2]

Member Function Documentation

◆ closeReplaceNextDialog()

◆ displayFinalDialog()

◆ numReplacements()

◆ replace() [1/2]

◆ replace() [2/2]

◆ replaceNextDialog()

◆ resetCounts()

◆ shouldRestart()

◆ textReplaced