X-Git-Url: http://secure.phpeclipse.com
diff --git a/net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/ISpellCheckEngine.java b/net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/ISpellCheckEngine.java
new file mode 100644
index 0000000..b857bd7
--- /dev/null
+++ b/net.sourceforge.phpeclipse.ui/src/net/sourceforge/phpdt/internal/ui/text/spelling/engine/ISpellCheckEngine.java
@@ -0,0 +1,89 @@
+/*******************************************************************************
+ * 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.Locale;
+
+import org.eclipse.jface.preference.IPreferenceStore;
+
+/**
+ * Interface for spell-check engines.
+ *
+ * @since 3.0
+ */
+public interface ISpellCheckEngine {
+
+ /**
+ * Creates a configured instance of a spell-checker that uses the
+ * appropriate dictionaries.
+ *
+ * @param locale
+ * The locale to get the spell checker for
+ * @param store
+ * The preference store for the spell-checker
+ * @return A configured instance of a spell checker, or null
+ * iff no dictionary could be found for that locale
+ */
+ ISpellChecker createSpellChecker(Locale locale, IPreferenceStore store);
+
+ /**
+ * Returns the current locale of the spell check engine.
+ *
+ * @return The current locale of the engine
+ */
+ Locale getLocale();
+
+ /**
+ * Registers a dictionary for all locales available on the platform.
+ *
+ * This call is equivalent to calling
+ * registerDictionary(Locale,ISpellDictionary)
for each of
+ * the locales returned by Locale.getAvailableLocales()
.
+ *
+ * All registered dictionaries are unloaded and the engine unregisters for
+ * preference changes. After a new call to
+ * getSpellChecker(Locale)
, it registers again for
+ * preference changes. The dictionaries perform lazy loading, that is to say
+ * on the next query they reload their associated word lists.
+ */
+ void unload();
+
+ /**
+ * Unregisters a dictionary previously registered either by a call to
+ * registerDictionary(Locale,ISpellDictionary)
or
+ * registerDictionary(ISpellDictionary)
. If the dictionary
+ * was not registered before, nothing happens.
+ *
+ * @param dictionary
+ * The dictionary to unregister
+ */
+ void unregisterDictionary(ISpellDictionary dictionary);
+}