KFind

Search for usage in LXR

#include <KFind>

Inheritance diagram for 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< OptionsSearchOptions
 

Signals

void dialogClosed ()
 
void findNext ()
 
void highlight (const QString &text, int matchingIndex, int matchedLength)
 
void highlight (int id, int matchingIndex, int matchedLength)
 
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 ()
 
QDialogfindNextDialog (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)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static int find (const QString &text, const QString &pattern, int index, long options, int *matchedlength)
 
static int find (const QString &text, const QRegExp &pattern, int index, long options, int *matchedlength)
 
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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Protected Member Functions

 KFind (KFindPrivate &dd, const QString &pattern, long options, QWidget *parent)
 
 KFind (KFindPrivate &dd, const QString &pattern, long options, QWidget *parent, QWidget *findDialog)
 
QWidgetdialogsParent () const
 
QWidgetparentWidget () 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

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[email protected][email protected][email protected]ee.or[email protected]g, David Faure faure[email protected]@kde[email protected].org, Arend van Beelen jr. arend[email protected]@aut[email protected]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

Stores a combination of Options values.

Definition at line 116 of file kfind.h.

Member Enumeration Documentation

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.

Constructor & Destructor Documentation

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 78 of file kfind.cpp.

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 93 of file kfind.cpp.

Member Function Documentation

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 777 of file kfind.cpp.

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.

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 701 of file kfind.cpp.

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 213 of file kfind.cpp.

int KFind::find ( const QString text,
const QString pattern,
int  index,
long  options,
int *  matchedlength 
)
static

Search the given string, and returns whether a match was found.

If one is, the length of the string matched is also returned.

A performance optimised version of the function is provided for use with regular expressions.

Parameters
textThe string to search.
patternThe pattern to look for.
indexThe starting index into the string.
optionsThe options to use.
matchedlengthThe length of the string that was matched
Returns
The index at which a match was found, or -1 if no match was found.
Deprecated:
Since 5.70

Definition at line 510 of file kfind.cpp.

int KFind::find ( const QString text,
const QRegExp pattern,
int  index,
long  options,
int *  matchedlength 
)
static
Deprecated:
Since 5.70, for lack of direct use

Definition at line 670 of file kfind.cpp.

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
textThe string to search in
patternThe pattern to search for
indexThe index in text from which to start the search
optionsThe options to use
matchedlengthIf there is a match, its length will be stored in this parameter
rmatchIf 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 517 of file kfind.cpp.

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 196 of file kfind.cpp.

void KFind::highlight ( 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 signal highlight(id, matchingIndex, matchedLength)

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()
Deprecated:
since 5.81, use the KFind::textFound(const QString &, int, int) signal instead.
void KFind::highlight ( 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()
Deprecated:
since 5.81, use the KFind::textFoundAtId(int id, int matchingIndex, int matchedLength) signal instead.
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 788 of file kfind.cpp.

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 131 of file kfind.cpp.

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 818 of file kfind.cpp.

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 753 of file kfind.cpp.

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.

QString KFind::pattern ( ) const
Returns
the pattern we're currently looking for

Definition at line 795 of file kfind.cpp.

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 825 of file kfind.cpp.

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

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

Parameters
datathe text fragment (line)
startPosif 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 149 of file kfind.cpp.

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
idthe id of the text fragment
datathe text fragment (line)
startPosif 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 154 of file kfind.cpp.

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 760 of file kfind.cpp.

void KFind::setPattern ( const QString pattern)

Change the pattern we're looking for.

Definition at line 802 of file kfind.cpp.

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
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 in KReplace.

Definition at line 714 of file kfind.cpp.

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
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
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
textThe current text fragment
indexThe starting index where the candidate match was found
matchedlengthThe length of the candidate match

Definition at line 832 of file kfind.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Mon Dec 6 2021 22:47:43 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.