org.kde.koala

Class KReplace

public class KReplace extends KFind

Author: S.R.Haque , David Faure

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 &&  ) {
          if ( m_replace.needData() )
              m_replace.setData(  );
          // Let KReplace inspect the text fragment, and display a dialog if a match is found
          res = m_replace.replace();
          if ( res == KFind.NoMatch ) {
              
          }
      }
      if ( res == KFind.NoMatch ) // i.e. at end
          
  }
 
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
StringclassName()
voidcloseReplaceNextDialog()
Close the "replace next?
voiddisplayFinalDialog()
Displays the final dialog telling the user how many replacements were made.
voiddispose()
Delete the wrapped C++ instance ahead of finalize()
protected voidfinalize()
Deletes the wrapped C++ instance
booleanisDisposed()
Has the wrapped C++ instance been deleted?
QMetaObjectmetaObject()
intnumReplacements()
Return the number of replacements made (i.e. the number of times the replace signal was emitted).
intreplace()
Walk the text fragment (e.g. kwrite line, kspread cell) looking for matches.
static intreplace(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 intreplace(StringBuffer text, QRegExp pattern, String replacement, int index, long options, int[] replacedLength)
KDialogBasereplaceNextDialog(boolean create)
Return (or create) the dialog that shows the "find next?
KDialogBasereplaceNextDialog()
voidresetCounts()
Call this to reset the numMatches & numReplacements counts.
booleanshouldRestart(boolean forceAsking, boolean showNumMatches)
Returns true if we should restart the search from scratch.
booleanshouldRestart(boolean forceAsking)
booleanshouldRestart()
protected voidslotReplace()
protected voidslotReplaceAll()
protected voidslotSkip()

Constructor Detail

KReplace

protected KReplace(Class dummy)

KReplace

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

UNKNOWN: Only use this constructor if you don't use KFindDialog, or if you use it as a modal dialog.

KReplace

public KReplace(String pattern, String replacement, long options)

KReplace

public KReplace(String pattern, String replacement, long options, QWidget parent, QWidget replaceDialog)
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.

UNKNOWN: This is the recommended constructor if you also use KReplaceDialog (non-modal).

Method Detail

className

public String className()

closeReplaceNextDialog

public void closeReplaceNextDialog()
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.

UNKNOWN: Close the "replace next?" dialog.

displayFinalDialog

public void displayFinalDialog()
Displays the final dialog telling the user how many replacements were made. Call either this or shouldRestart().

UNKNOWN: Displays the final dialog telling the user how many replacements were made.

dispose

public void dispose()
Delete the wrapped C++ instance ahead of finalize()

finalize

protected void finalize()
Deletes the wrapped C++ instance

isDisposed

public boolean isDisposed()
Has the wrapped C++ instance been deleted?

metaObject

public QMetaObject metaObject()

numReplacements

public int numReplacements()
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).

UNKNOWN: Return the number of replacements made (i.

replace

public int replace()
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.

UNKNOWN: Walk the text fragment (e.

replace

public 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. If one is, the replacement string length 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. 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.

replace

public static int replace(StringBuffer text, QRegExp pattern, String replacement, int index, long options, int[] replacedLength)

replaceNextDialog

public KDialogBase replaceNextDialog(boolean create)
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.

UNKNOWN: Return (or create) the dialog that shows the "find next?" prompt.

replaceNextDialog

public KDialogBase replaceNextDialog()

resetCounts

public void resetCounts()
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.

UNKNOWN: Call this to reset the numMatches & numReplacements counts.

shouldRestart

public boolean shouldRestart(boolean forceAsking, boolean showNumMatches)
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).

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.

shouldRestart

public boolean shouldRestart(boolean forceAsking)

shouldRestart

public boolean shouldRestart()

slotReplace

protected void slotReplace()

slotReplaceAll

protected void slotReplaceAll()

slotSkip

protected void slotSkip()