• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KFind Class Reference

A generic implementation of the "find" function. More...

#include <kfind.h>

Inheritance diagram for KFind:
QObject KReplace

List of all members.

Public Types

enum  Options {
  WholeWordsOnly = 1, FromCursor = 2, SelectedText = 4, CaseSensitive = 8,
  FindBackwards = 16, RegularExpression = 32, FindIncremental = 64, MinimumUserOption = 65536
}
enum  Result { NoMatch, Match }

Signals

void dialogClosed ()
void findNext ()
void highlight (int id, int matchingIndex, int matchedLength)
void highlight (const QString &text, int matchingIndex, int matchedLength)
void optionsChanged ()

Public Member Functions

void closeFindNextDialog ()
virtual void displayFinalDialog () const
Result find ()
KDialog * findNextDialog (bool create=false)
int index () const
 KFind (const QString &pattern, long options, QWidget *parent, QWidget *findDialog)
 KFind (const QString &pattern, long options, QWidget *parent)
bool needData () const
int numMatches () const
long options () const
QString pattern () const
virtual void resetCounts ()
void setData (int id, const QString &data, int startPos=-1)
void setData (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)
virtual ~KFind ()

Static Public Member Functions

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)

Protected Member Functions

QWidget * dialogsParent () const
QWidget * parentWidget () const

Detailed Description

A generic implementation of the "find" function.

Author:
S.R.Haque <srhaque@iee.org>, David Faure <faure@kde.org>, Arend van Beelen jr. <arend@auton.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 highlight signal to code which handles highlighting
  // of found text.
  connect( m_find, SIGNAL( highlight( const QString &, int, int ) ),
          this, SLOT( slotHighlight( const QString &, int, int ) ) );
  // Connect findNext signal - called when pressing the button in the dialog
  connect( m_find, SIGNAL( findNext() ),
          this, SLOT( slotFindNext() ) );

If you are using a non-modal find dialog (the recommended new way in KDE-3.2), you should call right away m_find->closeFindNextDialog().

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 = 0L;
           or           if ( m_find->shouldRestart() ) { reinit (w/o FromCursor) and call 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 101 of file kfind.h.


Member Enumeration Documentation

enum KFind::Options

the options

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 109 of file kfind.h.

enum KFind::Result
Enumerator:
NoMatch 
Match 

Definition at line 138 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 63 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 71 of file kfind.cpp.

KFind::~KFind (  )  [virtual]

Definition at line 92 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 649 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.

QWidget * KFind::dialogsParent (  )  const [protected]

Definition at line 697 of file kfind.cpp.

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

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

Definition at line 480 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:
text The string to search.
pattern The pattern to look for.
index The starting index into the string.
options The options to use.
matchedlength The length of the string that was matched
Returns:
The index at which a match was found, or -1 if no match was found.

Definition at line 403 of file kfind.cpp.

KFind::Result KFind::find (  ) 

Walk the text fragment (e.g.

text-processor line, kspread cell) looking for matches. For each match, emits the highlight() signal and displays the find-again dialog proceeding.

Definition at line 166 of file kfind.cpp.

void KFind::findNext (  )  [signal]
KDialog * 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 155 of file kfind.cpp.

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 signal with highlight(text, matchingIndex, matchedLength).

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()
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()
int KFind::index (  )  const
Returns:
the current matching index ( or -1 ). Same as the matchingIndex parameter passed to highlight. 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 658 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 98 of file kfind.cpp.

int KFind::numMatches (  )  const

Return the number of matches found (i.e.

the number of times the highlight 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.

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

QWidget * KFind::parentWidget (  )  const [protected]

Definition at line 692 of file kfind.cpp.

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

Definition at line 663 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 682 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:
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 116 of file kfind.cpp.

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

void KFind::setPattern ( const QString &  pattern  ) 

Change the pattern we're looking for.

Definition at line 668 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:
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 591 of file kfind.cpp.

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

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


The documentation for this class was generated from the following files:
  • kfind.h
  • kfind.cpp

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal