KFind

#include <KFind>

Inheritance diagram for KFind:

[legend]

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

Signals
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
	KFind (const QString &pattern, long options, QWidget *parent)

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

void	closeFindNextDialog ()

virtual void	displayFinalDialog () const

Result	find ()

QDialog *	findNextDialog (bool create=false)

int	index () const

bool	needData () const

int	numMatches () const

long	options () const

QString	pattern () const

virtual void	resetCounts ()

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

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

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

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
std::unique_ptr< class KFindPrivate > const	d_ptr

Additional Inherited Members
Properties inherited from QObject
	objectName

Public Attributes inherited from QObject
typedef	QObjectList

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

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

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.

Definition at line 93 of file kfind.h.

Member Typedef Documentation

◆ SearchOptions

typedef QFlags< Options > KFind::SearchOptions

Stores a combination of Options values.

Definition at line 116 of file kfind.h.

Member Enumeration Documentation

◆ Options

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

Definition at line 101 of file kfind.h.

◆ Result

enum KFind::Result

Definition at line 133 of file kfind.h.

Constructor & Destructor Documentation

◆ KFind() [1/4]

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.

Definition at line 74 of file kfind.cpp.

◆ KFind() [2/4]

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.

Definition at line 89 of file kfind.cpp.

◆ KFind() [3/4]

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

protected

Definition at line 79 of file kfind.cpp.

◆ KFind() [4/4]

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

protected

Definition at line 94 of file kfind.cpp.

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.

Definition at line 636 of file kfind.cpp.

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

◆ dialogsParent()

QWidget * KFind::dialogsParent ( ) const

protected

Definition at line 701 of file kfind.cpp.

◆ displayFinalDialog()

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.

Definition at line 567 of file kfind.cpp.

◆ find() [1/2]

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

Definition at line 205 of file kfind.cpp.

◆ find() [2/2]

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

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

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

Since: 5.70

Definition at line 489 of file kfind.cpp.

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

Definition at line 188 of file kfind.cpp.

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

Definition at line 647 of file kfind.cpp.

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

Definition at line 123 of file kfind.cpp.

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

Definition at line 677 of file kfind.cpp.

◆ 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

Definition at line 622 of file kfind.cpp.

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

◆ parentWidget()

QWidget * KFind::parentWidget ( ) const

protected

Definition at line 696 of file kfind.cpp.

◆ pattern()

QString KFind::pattern ( ) const

Returns: the pattern we're currently looking for

Definition at line 654 of file kfind.cpp.

◆ resetCounts()

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.

Definition at line 684 of file kfind.cpp.

◆ setData() [1/2]

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

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

Parameters

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.

Definition at line 141 of file kfind.cpp.

◆ 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

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.

Definition at line 146 of file kfind.cpp.

◆ setOptions()

void KFind::setOptions ( long options )

virtual

Set new options.

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

See also: KFind::Options

Definition at line 629 of file kfind.cpp.

◆ setPattern()

void KFind::setPattern ( const QString & pattern )

Change the pattern we're looking for.

Definition at line 661 of file kfind.cpp.

◆ shouldRestart()

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

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.

Definition at line 580 of file kfind.cpp.

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

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

text	The current text fragment
index	The starting index where the candidate match was found
matchedlength	The length of the candidate match

Definition at line 691 of file kfind.cpp.

Member Data Documentation

◆ d_ptr

std::unique_ptr<class KFindPrivate> const KFind::d_ptr

protected

Definition at line 370 of file kfind.h.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KTextWidgets

KFind

Public Types

Signals

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ SearchOptions

Member Enumeration Documentation

◆ Options

◆ Result

Constructor & Destructor Documentation

◆ KFind() [1/4]

◆ KFind() [2/4]

◆ KFind() [3/4]

◆ KFind() [4/4]

Member Function Documentation

◆ closeFindNextDialog()

◆ dialogClosed

◆ dialogsParent()

◆ displayFinalDialog()

◆ find() [1/2]

◆ find() [2/2]

◆ findNextDialog()

◆ index()

◆ needData()

◆ numMatches()

◆ options()

◆ optionsChanged

◆ parentWidget()

◆ pattern()

◆ resetCounts()

◆ setData() [1/2]

◆ setData() [2/2]

◆ setOptions()

◆ setPattern()

◆ shouldRestart()

◆ textFound

◆ textFoundAtId

◆ validateMatch()

Member Data Documentation

◆ d_ptr