<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<title>KReplace</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Style-Type" content="text/css" />
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
</head>
<body>
<div id="container">
<div id="header">
<div id="header_top">
<div>
<div>
<img alt ="" src="../common/top-kde.jpg"/>
KDE 4.9 PyKDE API Reference
</div>
</div>
</div>
<div id="header_bottom">
<div id="location">
<ul>
<li>KDE's Python API</li>
</ul>
</div>
<div id="menu">
<ul>
<li><a href="../modules.html">Overview</a></li>
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
<li><a href="http://kde.org/family/">Sitemap</a></li>
<li><a href="http://kde.org/contact/">Contact Us</a></li>
</ul>
</div>
</div>
</div>
<div id="body_wrapper">
<div id="body">
<div id="right">
<div class="content">
<div id="main">
<div class="clearer"> </div>
<h1>KReplace Class Reference</h1>
<code>from PyKDE4.kdeui import *</code>
<p>
Inherits: <a href="../kdeui/KFind.html">KFind</a> → QObject<br />
<h2>Detailed Description</h2>
<p>A generic implementation of the "replace" function.
</p>
<p>
<dl class="author" compact><dt><b>Author:</b></dt><dd> S.R.Haque <srhaque@iee.org>, David Faure <faure@kde.org> </dd></dl>
</p>
<p>
<b>Detail:</b>
</p>
<p>
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.
</p>
<p>
<b>Example:</b>
</p>
<p>
To use the class to implement a complete replace feature:
</p>
<p>
In the slot connect to the replace action, after using KReplaceDialog:
<pre class="fragment">
// 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, 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) ) );
</pre>
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();
</p>
<p>
<pre class="fragment">
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 = 0L;
or if ( m_replace->shouldRestart() ) { reinit (w/o FromCursor) and call slotReplaceNext(); }
else { m_replace->closeReplaceNextDialog(); }>
}
</pre>
</p>
<p>
Don't forget delete m_find in the destructor of your class,
unless you gave it a parent widget on construction.
</p>
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Signals</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#replace">replace</a> (QString text, int replacementIndex, int replacedLength, int matchedLength)</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KReplace">__init__</a> (self, QString pattern, QString replacement, long options, QWidget parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KReplace">__init__</a> (self, QString pattern, QString replacement, long options, QWidget parent, QWidget replaceDialog)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#closeReplaceNextDialog">closeReplaceNextDialog</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#displayFinalDialog">displayFinalDialog</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#numReplacements">numReplacements</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KFind.html#Result">KFind.Result</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#replace">replace</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KDialog.html">KDialog</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#replaceNextDialog">replaceNextDialog</a> (self, bool create=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#resetCounts">resetCounts</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#shouldRestart">shouldRestart</a> (self, bool forceAsking=0, bool showNumMatches=1)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, int replacedLength </td><td class="memItemRight" valign="bottom"><a class="el" href="#replace">replace</a> (QString text, QString pattern, QString replacement, int index, long options)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, int replacedLength </td><td class="memItemRight" valign="bottom"><a class="el" href="#replace">replace</a> (QString text, QRegExp pattern, QString replacement, int index, long options)</td></tr>
</table>
<hr><h2>Signal Documentation</h2><a class="anchor" name="replace"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> replace</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>replacementIndex</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>replacedLength</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>matchedLength</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Connect to this slot to implement updating of replaced text during the replace
operation.
</p>
<p>
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.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> The text, in which the replacement has already been done.
<tr><td></td><td valign="top"><em>replacementIndex</em> </td><td> Starting index of the matched substring
<tr><td></td><td valign="top"><em>replacedLength</em> </td><td> Length of the replacement string
<tr><td></td><td valign="top"><em>matchedLength</em> </td><td> Length of the matched string
</td></tr>
</table></dl>
<p>
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("replace(const QString&, int, int, int)"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KReplace"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>replacement</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Only use this constructor if you don't use KFindDialog, or if
you use it as a modal dialog.
</p></div></div><a class="anchor" name="KReplace"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>replacement</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>options</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>parent</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QWidget </td>
<td class="paramname"><em>replaceDialog</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>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.
</p></div></div><a class="anchor" name="closeReplaceNextDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> closeReplaceNextDialog</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>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.
</p></div></div><a class="anchor" name="displayFinalDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> displayFinalDialog</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Displays the final dialog telling the user how many replacements were made.
Call either this or shouldRestart().
</p></div></div><a class="anchor" name="numReplacements"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int numReplacements</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>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).
</p></div></div><a class="anchor" name="replace"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KFind.html#Result">KFind.Result</a> replace</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Connect to this slot to implement updating of replaced text during the replace
operation.
</p>
<p>
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.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> The text, in which the replacement has already been done.
<tr><td></td><td valign="top"><em>replacementIndex</em> </td><td> Starting index of the matched substring
<tr><td></td><td valign="top"><em>replacedLength</em> </td><td> Length of the replacement string
<tr><td></td><td valign="top"><em>matchedLength</em> </td><td> Length of the matched string
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="replaceNextDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdeui/KDialog.html">KDialog</a> replaceNextDialog</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>create=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>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.
</p></div></div><a class="anchor" name="resetCounts"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> resetCounts</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>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.
</p></div></div><a class="anchor" name="shouldRestart"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool shouldRestart</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>forceAsking=0</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>showNumMatches=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>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).
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>forceAsking</em> </td><td> set to true if the user modified the document during the
search. In that case it makes sense to restart the search again.
</td></tr>
<tr><td></td><td valign="top"><em>showNumMatches</em> </td><td> 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).
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="replace"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, int replacedLength replace</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>replacement</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>options</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Connect to this slot to implement updating of replaced text during the replace
operation.
</p>
<p>
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.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> The text, in which the replacement has already been done.
<tr><td></td><td valign="top"><em>replacementIndex</em> </td><td> Starting index of the matched substring
<tr><td></td><td valign="top"><em>replacedLength</em> </td><td> Length of the replacement string
<tr><td></td><td valign="top"><em>matchedLength</em> </td><td> Length of the matched string
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="replace"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, int replacedLength replace</td>
<td>(</td>
<td class="paramtype">QString </td>
<td class="paramname"><em>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QRegExp </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">QString </td>
<td class="paramname"><em>replacement</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>index</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>options</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Connect to this slot to implement updating of replaced text during the replace
operation.
</p>
<p>
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.
</p>
<p>
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> The text, in which the replacement has already been done.
<tr><td></td><td valign="top"><em>replacementIndex</em> </td><td> Starting index of the matched substring
<tr><td></td><td valign="top"><em>replacedLength</em> </td><td> Length of the replacement string
<tr><td></td><td valign="top"><em>matchedLength</em> </td><td> Length of the matched string
</td></tr>
</table></dl>
<p>
</p></div></div>
</div>
</div>
</div>
<div id="left">
<div class="menu_box">
<div class="nav_list">
<ul>
<li><a href="../allclasses.html">Full Index</a></li>
</ul>
</div>
<a name="cp-menu" /><div class="menutitle"><div>
<h2 id="cp-menu-project">Modules</h2>
</div></div>
<div class="nav_list">
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
<li><a href="../dnssd/index.html">dnssd</a></li>
<li><a href="../kdecore/index.html">kdecore</a></li>
<li><a href="../kdeui/index.html">kdeui</a></li>
<li><a href="../khtml/index.html">khtml</a></li>
<li><a href="../kio/index.html">kio</a></li>
<li><a href="../knewstuff/index.html">knewstuff</a></li>
<li><a href="../kparts/index.html">kparts</a></li>
<li><a href="../kutils/index.html">kutils</a></li>
<li><a href="../nepomuk/index.html">nepomuk</a></li>
<li><a href="../phonon/index.html">phonon</a></li>
<li><a href="../plasma/index.html">plasma</a></li>
<li><a href="../polkitqt/index.html">polkitqt</a></li>
<li><a href="../solid/index.html">solid</a></li>
<li><a href="../soprano/index.html">soprano</a></li>
</ul></div></div>
</div>
</div>
<div class="clearer"/>
</div>
<div id="end_body"></div>
</div>
<div id="footer"><div id="footer_text">
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
