org.kde.koala
public class KReplace extends KFind
UNKNOWN: A generic implementation of the "replace" function.
etail:
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.
xample:
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, this);
// Connect signals to code which handles highlighting
// of found text, and on-the-fly replacement.
connect( m_replace, SIGNAL("highlight( String, int, int )"),
this, SLOT("slotHighlight( String, 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(String, int, int, int)"),
this, SLOT("slotReplace(String, 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 &&
Don't forget delete m_find in the destructor of your class,
unless you gave it a parent widget on construction.
See KReplaceSignals for signals emitted by KReplace @brief A generic implementation of the "replace" function.
Constructor Summary | |
---|---|
protected | KReplace(Class dummy) |
KReplace(String pattern, String replacement, long options, QWidget parent)
Only use this constructor if you don't use KFindDialog, or if
you use it as a modal dialog. | |
KReplace(String pattern, String replacement, long options) | |
KReplace(String pattern, String replacement, long options, QWidget parent, QWidget replaceDialog)
This is the recommended constructor if you also use KReplaceDialog (non-modal).
|
Method Summary | |
---|---|
String | className() |
void | closeReplaceNextDialog()
Close the "replace next? |
void | displayFinalDialog()
Displays the final dialog telling the user how many replacements were made.
|
void | dispose() Delete the wrapped C++ instance ahead of finalize() |
protected void | finalize() Deletes the wrapped C++ instance |
boolean | isDisposed() Has the wrapped C++ instance been deleted? |
QMetaObject | metaObject() |
int | numReplacements()
Return the number of replacements made (i.e. the number of times
the replace signal was emitted).
|
int | replace()
Walk the text fragment (e.g. kwrite line, kspread cell) looking for matches.
|
static int | replace(StringBuffer text, String pattern, String replacement, int index, long options, int[] replacedLength)
Search the given string, replaces with the given replacement string,
and returns whether a match was found. |
static int | replace(StringBuffer text, QRegExp pattern, String replacement, int index, long options, int[] replacedLength) |
KDialogBase | replaceNextDialog(boolean create)
Return (or create) the dialog that shows the "find next? |
KDialogBase | replaceNextDialog() |
void | resetCounts()
Call this to reset the numMatches & numReplacements counts.
|
boolean | shouldRestart(boolean forceAsking, boolean showNumMatches)
Returns true if we should restart the search from scratch.
|
boolean | shouldRestart(boolean forceAsking) |
boolean | shouldRestart() |
protected void | slotReplace() |
protected void | slotReplaceAll() |
protected void | slotSkip() |
UNKNOWN: Only use this constructor if you don't use KFindDialog, or if you use it as a modal dialog.
UNKNOWN: This is the recommended constructor if you also use KReplaceDialog (non-modal).
UNKNOWN: Close the "replace next?" dialog.
UNKNOWN: Displays the final dialog telling the user how many replacements were made.
UNKNOWN: Return the number of replacements made (i.
UNKNOWN: Walk the text fragment (e.
Parameters: text The string to search. pattern The pattern to look for. replacement The replacement string to insert into the text. index The starting index into the string. options The options to use. replacedLength Output parameter, contains the length of the replaced string. Not always the same as replacement.length(), when backreferences are used.
Returns: The index at which a match was found, or -1 if no match was found.
UNKNOWN: Search the given string, replaces with the given replacement string, and returns whether a match was found.
UNKNOWN: Return (or create) the dialog that shows the "find next?" prompt.
UNKNOWN: Call this to reset the numMatches & numReplacements counts.
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).
UNKNOWN: Returns true if we should restart the search from scratch.