blob: f95735d9b5f8413571486004dd5ad5de0fbab8ec (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
/*******************************************************************************
* Copyright (c) 2000, 2005 IBM Corporation and others.
*
* This program and the accompanying materials
* are made available under the terms of the Eclipse Public License 2.0
* which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-2.0/
*
* SPDX-License-Identifier: EPL-2.0
*
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
package org.eclipse.ui.texteditor.spelling;
import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.IRegion;
/**
* A spelling engine that can be contributed to the
* <code>org.eclipse.ui.workbench.texteditor.spellingEngine</code> extension
* point. The <code>SpellingContext</code> provides information about the
* content type to be checked. In general a spelling engine should at least
* support the text {@link org.eclipse.core.runtime.content.IContentType content type}.
* <p>
* This interface is intended to be implemented by clients.
* </p>
*
* @since 3.1
*/
public interface ISpellingEngine {
/**
* Checks the given regions in the given document. Reports all found
* spelling problems to the collector.
*
* @param document the document to check
* @param regions the regions to check
* @param context the context
* @param collector the problem collector
* @param monitor the progress monitor, can be <code>null</code>
*/
public void check(IDocument document, IRegion[] regions, SpellingContext context, ISpellingProblemCollector collector, IProgressMonitor monitor);
}
|
