X-Git-Url: http://secure.phpeclipse.com

diff --git a/net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/ISpellChecker.java b/net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/ISpellChecker.java
new file mode 100644
index 0000000..13a9a92
--- /dev/null
+++ b/net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/ISpellChecker.java
@@ -0,0 +1,118 @@
+/*******************************************************************************
+ * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * All rights reserved. This program and the accompanying materials 
+ * are made available under the terms of the Common Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/cpl-v10.html
+ * 
+ * Contributors:
+ *     IBM Corporation - initial API and implementation
+ *******************************************************************************/
+
+package net.sourceforge.phpdt.internal.ui.text.spelling.engine;
+
+import java.util.Set;
+
+/**
+ * Interface for spell-checkers.
+ * 
+ * @since 3.0
+ */
+public interface ISpellChecker {
+
+	/**
+	 * Adds a dictionary to the list of active dictionaries.
+	 * 
+	 * @param dictionary
+	 *            The dictionary to add
+	 */
+	public void addDictionary(ISpellDictionary dictionary);
+
+	/**
+	 * Adds a spell event listener to the active listeners.
+	 * 
+	 * @param listener
+	 *            The listener to add
+	 */
+	public void addListener(ISpellEventListener listener);
+
+	/**
+	 * Returns whether this spell checker accepts word additions.
+	 * 
+	 * @return <code>true</code> if word additions are accepted,
+	 *         <code>false</code> otherwise
+	 */
+	public boolean acceptsWords();
+
+	/**
+	 * Adds the specified word to the set of correct words.
+	 * 
+	 * @param word
+	 *            The word to add to the set of correct words
+	 */
+	public void addWord(String word);
+
+	/**
+	 * Checks the specified word until calling <code>ignoreWord(String)</code>.
+	 * 
+	 * @param word
+	 *            The word to check
+	 */
+	public void checkWord(String word);
+
+	/**
+	 * Checks the spelling with the spell-check iterator. Implementations must
+	 * be thread safe as this may be called inside a reconciler thread.
+	 * 
+	 * @param iterator
+	 *            The iterator to use for spell-checking
+	 */
+	public void execute(ISpellCheckIterator iterator);
+
+	/**
+	 * Returns the ranked proposals for a word.
+	 * 
+	 * @param word
+	 *            The word to retrieve the proposals for
+	 * @param sentence
+	 *            <code>true</code> iff the proposals should start a sentence,
+	 *            <code>false</code> otherwise
+	 * @return Set of ranked proposals for the word
+	 */
+	public Set getProposals(String word, boolean sentence);
+
+	/**
+	 * Ignores the specified word until calling <code>checkWord(String)</code>.
+	 * 
+	 * @param word
+	 *            The word to ignore
+	 */
+	public void ignoreWord(String word);
+
+	/**
+	 * Is the specified word correctly spelled? Implementations must be thread
+	 * safe as this may be called from within a reconciler thread.
+	 * 
+	 * @param word
+	 *            The word to check its spelling
+	 * @return <code>true</code> iff the word is correctly spelled,
+	 *         <code>false</code> otherwise
+	 */
+	public boolean isCorrect(String word);
+
+	/**
+	 * Remove a dictionary from the list of active dictionaries.
+	 * 
+	 * @param dictionary
+	 *            The dictionary to remove
+	 */
+	public void removeDictionary(ISpellDictionary dictionary);
+
+	/**
+	 * Removes a spell event listener from the active listeners.
+	 * 
+	 * @param listener
+	 *            The listener to remove
+	 */
+	public void removeListener(ISpellEventListener listener);
+}