KReplace Class Reference
A generic implementation of the "replace" function. More...
#include <kreplace.h>
Inheritance diagram for KReplace:

Signals | |
void | replace (const QString &text, int replacementIndex, int replacedLength, int matchedLength) |
Connect to this slot to implement updating of replaced text during the replace operation. | |
Public Methods | |
KReplace (const QString &pattern, const QString &replacement, long options, QWidget *parent=0) | |
Will create a prompt dialog and use it as needed. | |
int | numReplacements () const |
Return the number of replacements made (i.e. | |
virtual void | resetCounts () |
Call this to reset the numMatches & numReplacements counts. | |
Result | replace () |
Walk the text fragment (e.g. | |
KDialogBase * | replaceNextDialog (bool create=false) |
Return (or create) the dialog that shows the "find next?" prompt. | |
void | closeReplaceNextDialog () |
Close the "replace next?" dialog. | |
virtual bool | shouldRestart (bool forceAsking=false, bool showNumMatches=true) const |
Returns true if we should restart the search from scratch. | |
virtual void | displayFinalDialog () const |
Displays the final dialog telling the user how many replacements were made. | |
Static Public Methods | |
int | replace (QString &text, const QString &pattern, const QString &replacement, int index, long options, int *replacedLength) |
Search the given string, replaces with the given replacement string, and returns whether a match was found. |
Detailed Description
A generic implementation of the "replace" function.
- Author:
- S.R.Haque <srhaque@iee.org>, David Faure <faure@kde.org>
Detail
This class includes prompt handling etc. Also provides some static functions which can be used to create custom behaviour 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); // Connect signals to code which handles highlighting // of found text, and on-the-fly replacement. connect( m_replace, 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_replace, SIGNAL( findNext() ), this, SLOT( slotReplaceNext() ) ); // Connect replace signal - called when doing a replacement connect( m_replace, SIGNAL( replace(const QString &, int, int, int) ), this, SLOT( slotReplace(const QString &, int, int, int) ) ); 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->res(); if ( res == KFind::NoMatch ) { <Move to the next non-empty text fragment, honouring the FindBackwards setting for the direction> } } if ( res == KFind::NoMatch ) // i.e. at end <Call either m_replace->displayFinalDialog(); delete m_replace; m_replace = 0L; or if ( m_replace->shouldRestart() ) { reinit and call slotReplaceNext(); } else { delete m_replace; m_replace = 0L; }> }Don't forget delete m_find in the destructor of your class, unless you gave it a parent widget on construction.
Definition at line 96 of file kreplace.h.
Constructor & Destructor Documentation
|
Will create a prompt dialog and use it as needed.
Definition at line 63 of file kreplace.cpp. |
Member Function Documentation
|
Return the number of replacements made (i.e. the number of times the replace 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 113 of file kreplace.h. |
|
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 273 of file kreplace.cpp. References KFind::resetCounts(). |
|
Walk the text fragment (e.g. kwrite line, kspread cell) looking for matches. For each match, if prompt-on-replace is specified, emits the highlight() signal and displays the prompt-for-replace dialog before doing the replace. Definition at line 103 of file kreplace.cpp. References KFind::find(), KFind::highlight(), QDialog::show(), and KFind::validateMatch(). Referenced by replace(). |
|
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 75 of file kreplace.cpp. References KStdAction::create(). |
|
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 303 of file kreplace.cpp. References KFind::closeFindNextDialog(). |
|
Search the given string, replaces with the given replacement string, and returns whether a match was found. If one is, the replacement string length is also returned. A performance optimised version of the function is provided for use with regular expressions.
Definition at line 180 of file kreplace.cpp. References KFind::find(), KFind::options(), and replace(). |
|
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).
Reimplemented from KFind. Definition at line 279 of file kreplace.cpp. References displayFinalDialog(), and KMessageBox::questionYesNo(). |
|
Displays the final dialog telling the user how many replacements were made. Call either this or shouldRestart(). Reimplemented from KFind. Definition at line 95 of file kreplace.cpp. References KMessageBox::information(). Referenced by shouldRestart(). |
|
Connect to this slot 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 highlight 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.
|
The documentation for this class was generated from the following files: