Mercurial > projects > dwt-addons
diff dwtx/jface/text/IFindReplaceTargetExtension3.d @ 129:eb30df5ca28b
Added JFace Text sources
author | Frank Benoit <benoit@tionex.de> |
---|---|
date | Sat, 23 Aug 2008 19:10:48 +0200 |
parents | |
children | c4fb132a086c |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwtx/jface/text/IFindReplaceTargetExtension3.d Sat Aug 23 19:10:48 2008 +0200 @@ -0,0 +1,65 @@ +/******************************************************************************* + * Copyright (c) 2000, 2005 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + * Port to the D programming language: + * Frank Benoit <benoit@tionex.de> + *******************************************************************************/ + +module dwtx.jface.text.IFindReplaceTargetExtension3; + +import dwt.dwthelper.utils; + +/** + * Extension interface for {@link dwtx.jface.text.IFindReplaceTarget}. + * <p> + * Extends the find replace target's <code>findAndSelect</code> and + * <code>replaceSelection</code> methods to allow and be aware of regular + * expression find/replace. + * + * @since 3.0 + */ +public interface IFindReplaceTargetExtension3 { + + /** + * Searches for a string starting at the given offset and using the specified search + * directives. If a string has been found it is selected and its start offset is + * returned. If regExSearch is <code>true</code> the findString is + * interpreted as a regular expression. + * + * @param offset the offset at which searching starts + * @param findString the specification of what should be found + * @param searchForward <code>true</code> searches forward, <code>false</code> backwards + * @param caseSensitive <code>true</code> performs a case sensitive search, <code>false</code> an insensitive search + * @param wholeWord if <code>true</code> only occurrences are reported in which the findString stands as a word by itself. + * Must not be used in combination with <code>regExSearch</code>. + * @param regExSearch if <code>true</code> findString represents a regular expression + * Must not be used in combination with <code>wholeWord</code>. + * @return the position of the specified string, or -1 if the string has not been found + * @throws java.util.regex.PatternSyntaxException if regExSearch is <code>true</code> and findString is an invalid regular expression + */ + int findAndSelect(int offset, String findString, bool searchForward, bool caseSensitive, bool wholeWord, bool regExSearch); + + /** + * Replaces the currently selected range of characters with the given text. + * If regExReplace is <code>true</code> the text is interpreted as a + * regular expression that is used to process the selected text in order to + * produce the actual replacement of the selected text. + * <p> + * This target must be editable. Otherwise nothing happens. + * + * @param text the specification of the substitution text + * @param regExReplace if <code>true</code> text represents a regular + * expression + * @throws IllegalStateException in case of regular expressions, this call + * is not preceded by a call to <code>findAndSelect</code> + * @throws java.util.regex.PatternSyntaxException if regExReplace is + * <code>true</code> and text is an invalid regular expression + */ + void replaceSelection(String text, bool regExReplace); +}