b11c8175f7f223631c057aa697ede219bbdef47b
[phpeclipse.git] /
1 /*******************************************************************************
2  * Copyright (c) 2000, 2003 IBM Corporation and others.
3  * All rights reserved. This program and the accompanying materials 
4  * are made available under the terms of the Common Public License v1.0
5  * which accompanies this distribution, and is available at
6  * http://www.eclipse.org/legal/cpl-v10.html
7  * 
8  * Contributors:
9  *     IBM Corporation - initial API and implementation
10  *******************************************************************************/
11
12 package net.sourceforge.phpdt.internal.ui.text.spelling.engine;
13
14 /**
15  * Preference keys for the comment spell-checker.
16  * 
17  * @since 3.0
18  */
19 public interface ISpellCheckPreferenceKeys {
20
21         /**
22          * A named preference that controls whether spell-checking should be
23          * enabled.
24          * <p>
25          * Value is of type <code>Boolean</code>.
26          * </p>
27          */
28         public final static String SPELLING_CHECK_SPELLING = "spelling_check_spelling"; //$NON-NLS-1$
29
30         /**
31          * A named preference that controls whether words containing digits should
32          * be skipped during spell-checking.
33          * <p>
34          * Value is of type <code>Boolean</code>.
35          * </p>
36          */
37         public final static String SPELLING_IGNORE_DIGITS = "spelling_ignore_digits"; //$NON-NLS-1$
38
39         /**
40          * A named preference that controls whether mixed case words should be
41          * skipped during spell-checking.
42          * <p>
43          * Value is of type <code>Boolean</code>.
44          * </p>
45          */
46         public final static String SPELLING_IGNORE_MIXED = "spelling_ignore_mixed"; //$NON-NLS-1$
47
48         /**
49          * A named preference that controls whether sentence capitalization should
50          * be ignored during spell-checking.
51          * <p>
52          * Value is of type <code>Boolean</code>.
53          * </p>
54          */
55         public final static String SPELLING_IGNORE_SENTENCE = "spelling_ignore_sentence"; //$NON-NLS-1$
56
57         /**
58          * A named preference that controls whether upper case words should be
59          * skipped during spell-checking.
60          * <p>
61          * Value is of type <code>Boolean</code>.
62          * </p>
63          */
64         public final static String SPELLING_IGNORE_UPPER = "spelling_ignore_upper"; //$NON-NLS-1$
65
66         /**
67          * A named preference that controls whether urls should be ignored during
68          * spell-checking.
69          * <p>
70          * Value is of type <code>Boolean</code>.
71          * </p>
72          */
73         public final static String SPELLING_IGNORE_URLS = "spelling_ignore_urls"; //$NON-NLS-1$
74
75         /**
76          * A named preference that controls the locale used for spell-checking.
77          * <p>
78          * Value is of type <code>String</code>.
79          * </p>
80          */
81         public final static String SPELLING_LOCALE = "spelling_locale"; //$NON-NLS-1$
82
83         /**
84          * A named preference that controls the number of proposals offered during
85          * spell-checking.
86          * <p>
87          * Value is of type <code>Integer</code>.
88          * </p>
89          */
90         public final static String SPELLING_PROPOSAL_THRESHOLD = "spelling_proposal_threshold"; //$NON-NLS-1$
91
92         /**
93          * A named preference that specifies the workspace user dictionary.
94          * <p>
95          * Value is of type <code>String</code>.
96          * </p>
97          */
98         public final static String SPELLING_USER_DICTIONARY = "spelling_user_dictionary"; //$NON-NLS-1$
99
100         /**
101          * A named preference that specifies whether spelling dictionaries are
102          * available to content assist.
103          * <p>
104          * Value is of type <code>Boolean</code>.
105          * </p>
106          */
107         public final static String SPELLING_ENABLE_CONTENTASSIST = "spelling_enable_contentassist"; //$NON-NLS-1$
108 }