Fix bugs #725 and releted #744
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / IPreferenceConstants.java
1 /**********************************************************************
2  Copyright (c) 2000, 2002 IBM Corp. 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 implementation
10  www.phpeclipse.de
11  **********************************************************************/
12 package net.sourceforge.phpeclipse;
13
14 /**
15  * Predefined prference constants
16  */
17 public interface IPreferenceConstants {
18         /**
19          * Preference key suffix for bold text style preference keys.
20          * 
21          * @since 2.1
22          */
23         public static final String EDITOR_BOLD_SUFFIX = "_bold"; //$NON-NLS-1$
24
25         /**
26          * Preference key suffix for italic text style preference keys.
27          * 
28          * @since 3.0
29          */
30         public static final String EDITOR_ITALIC_SUFFIX = "_italic"; //$NON-NLS-1$
31
32         // public static final String LOCALHOST_PREF = "_localhost";
33         // public static final String DOCUMENTROOT_PREF = "_documentroot";
34         // public static final String XAMPP_START_PREF = "_xampp_start_pref";
35         //
36         // public static final String XAMPP_STOP_PREF = "_xampp_stop_pref";
37         //
38         // public static final String MYSQL_RUN_PREF = "_mysql_run_pref";
39         //
40         // public static final String MYSQL_START_BACKGROUND =
41         // "_mysql_start_background";
42         //
43         // public static final String MYSQL_PREF = "__mysql_start";
44         //
45         // public static final String APACHE_RUN_PREF = "_apache_run_pref";
46         //
47         // public static final String APACHE_START_BACKGROUND =
48         // "_apache_start_background";
49         //
50         // public static final String APACHE_START_PREF = "__apache_start";
51         //
52         // public static final String APACHE_STOP_BACKGROUND =
53         // "_apache_stop_background";
54         //
55         // public static final String APACHE_STOP_PREF = "__apache_stop";
56         //
57         // public static final String APACHE_RESTART_BACKGROUND =
58         // "_apache_restart_background";
59         //
60         // public static final String APACHE_RESTART_PREF = "__apache_restart";
61
62         // public static final String HTTPD_CONF_PATH_PREF = "__httpd_conf_path";
63         //
64         // public static final String ETC_HOSTS_PATH_PREF = "__etc_hosts_path";
65
66         // public static final String SHOW_OUTPUT_IN_CONSOLE =
67         // "_show_output_in_console";
68
69         // public static final String PHP_RUN_PREF = "_php_run_pref";
70         //
71         // public static final String EXTERNAL_PARSER_PREF = "_external_parser";
72
73         // public static final String PHP_EXTENSION_PREFS =
74         // "_php_parser_extensions";
75
76         // public static final String PHP_PARSER_DEFAULT = "_php_parser_default";
77
78         // public static final String PHP_INTERNAL_PARSER = "_php_internal_parser";
79         // public static final String PHP_EXTERNAL_PARSER = "_php_external_parser";
80         // public static final String PHP_PARSE_ON_SAVE = "_php_parse_on_save";
81         public static final String PHP_MULTILINE_COMMENT = "_php_multilineComment";
82
83         public static final String PHP_MULTILINE_COMMENT_BOLD = "_php_multilineComment_bold";
84
85         public static final String PHP_MULTILINE_COMMENT_ITALIC = "_php_multilineComment_italic";
86
87         public static final String PHP_MULTILINE_COMMENT_UNDERLINE = "_php_multilineComment_underline";
88
89         /**
90          * The color key for operators and brackets in PHP code (value
91          * <code>"__php_operator"</code>).
92          * 
93          * @since 3.0
94          */
95         public static final String PHP_OPERATOR = "__php_operator"; //$NON-NLS-1$
96
97         /**
98          * The color key for {} in PHP code (value
99          * <code>"__php_brace_operator"</code>).
100          * 
101          * @since 3.0
102          */
103         public static final String PHP_BRACE_OPERATOR = "__php_brace_operator"; //$NON-NLS-1$
104
105         /**
106          * A named preference that holds the color used to render operators and
107          * brackets.
108          * <p>
109          * Value is of type <code>String</code>. A RGB color value encoded as a
110          * string using class <code>PreferenceConverter</code>
111          * </p>
112          * 
113          * @see org.eclipse.jface.resource.StringConverter
114          * @see org.eclipse.jface.preference.PreferenceConverter
115          * @since 3.0
116          */
117         public final static String EDITOR_PHP_OPERATOR_COLOR = PHP_OPERATOR;
118
119         /**
120          * A named preference that controls whether operators and brackets are
121          * rendered in bold.
122          * <p>
123          * Value is of type <code>Boolean</code>.
124          * </p>
125          * 
126          * @since 3.0
127          */
128         public final static String EDITOR_PHP_OPERATOR_BOLD = PHP_OPERATOR
129                         + EDITOR_BOLD_SUFFIX;
130
131         /**
132          * A named preference that controls whether operators and brackets are
133          * rendered in italic.
134          * <p>
135          * Value is of type <code>Boolean</code>.
136          * </p>
137          * 
138          * @since 3.0
139          */
140         public final static String EDITOR_PHP_OPERATOR_ITALIC = PHP_OPERATOR
141                         + EDITOR_ITALIC_SUFFIX;
142
143         /**
144          * A named preference that holds the color used to render operators and
145          * brackets.
146          * <p>
147          * Value is of type <code>String</code>. A RGB color value encoded as a
148          * string using class <code>PreferenceConverter</code>
149          * </p>
150          * 
151          * @see org.eclipse.jface.resource.StringConverter
152          * @see org.eclipse.jface.preference.PreferenceConverter
153          * @since 3.0
154          */
155         public final static String EDITOR_PHP_BRACE_OPERATOR_COLOR = PHP_BRACE_OPERATOR;
156
157         /**
158          * A named preference that controls whether operators and brackets are
159          * rendered in bold.
160          * <p>
161          * Value is of type <code>Boolean</code>.
162          * </p>
163          * 
164          * @since 3.0
165          */
166         public final static String EDITOR_PHP_BRACE_OPERATOR_BOLD = PHP_BRACE_OPERATOR
167                         + EDITOR_BOLD_SUFFIX;
168
169         /**
170          * A named preference that controls whether operators and brackets are
171          * rendered in italic.
172          * <p>
173          * Value is of type <code>Boolean</code>.
174          * </p>
175          * 
176          * @since 3.0
177          */
178         public final static String EDITOR_PHP_BRACE_OPERATOR_ITALIC = PHP_BRACE_OPERATOR
179                         + EDITOR_ITALIC_SUFFIX;
180
181         /**
182          * The color key for keyword 'return' in PHP code (value
183          * <code>"__php_keyword_return"</code>).
184          * 
185          * @since 3.0
186          */
187         public static final String PHP_KEYWORD_RETURN = "__php_keyword_return"; //$NON-NLS-1$
188
189         /**
190          * A named preference that holds the color used to render the 'return'
191          * keyword.
192          * <p>
193          * Value is of type <code>String</code>. A RGB color value encoded as a
194          * string using class <code>PreferenceConverter</code>
195          * </p>
196          * 
197          * @see org.eclipse.jface.resource.StringConverter
198          * @see org.eclipse.jface.preference.PreferenceConverter
199          * @since 3.0
200          */
201         public final static String EDITOR_PHP_KEYWORD_RETURN_COLOR = PHP_KEYWORD_RETURN;
202
203         /**
204          * A named preference that controls whether 'return' keyword is rendered in
205          * bold.
206          * <p>
207          * Value is of type <code>Boolean</code>.
208          * </p>
209          * 
210          * @since 3.0
211          */
212         public final static String EDITOR_PHP_KEYWORD_RETURN_BOLD = PHP_KEYWORD_RETURN
213                         + EDITOR_BOLD_SUFFIX;
214
215         /**
216          * A named preference that controls whether 'return' keyword is rendered in
217          * italic.
218          * <p>
219          * Value is of type <code>Boolean</code>.
220          * </p>
221          * 
222          * @since 3.0
223          */
224         public final static String EDITOR_PHP_KEYWORD_RETURN_ITALIC = PHP_KEYWORD_RETURN
225                         + EDITOR_ITALIC_SUFFIX;
226
227         public static final String PHP_SINGLELINE_COMMENT = "_php_singlelineComment";
228
229         public static final String PHP_SINGLELINE_COMMENT_BOLD = "_php_singlelineComment_bold";//$NON-NLS-1$
230
231         public static final String PHP_SINGLELINE_COMMENT_ITALIC = "_php_singlelineComment_italic";//$NON-NLS-1$
232
233         public static final String PHP_SINGLELINE_COMMENT_UNDERLINE = "_php_singlelineComment_underline";//$NON-NLS-1$
234
235         public static final String PHP_TAG = "_php_tag";//$NON-NLS-1$
236
237         public static final String PHP_TAG_BOLD = "_php_tag_bold";//$NON-NLS-1$
238
239         public static final String PHP_TAG_ITALIC = "_php_tag_italic";//$NON-NLS-1$
240
241         public static final String PHP_TAG_UNDERLINE = "_php_tag_underline";//$NON-NLS-1$
242
243         public static final String PHP_KEYWORD = "_php_keyword";//$NON-NLS-1$
244
245         public static final String PHP_KEYWORD_BOLD = "_php_keyword_bold";//$NON-NLS-1$
246
247         public static final String PHP_KEYWORD_ITALIC = "_php_keyword_italic";//$NON-NLS-1$
248
249         public static final String PHP_KEYWORD_UNDERLINE = "_php_keyword_underline";//$NON-NLS-1$
250
251         public static final String PHP_VARIABLE = "_php_variable";//$NON-NLS-1$
252
253         public static final String PHP_VARIABLE_BOLD = "_php_variable_bold";//$NON-NLS-1$
254
255         public static final String PHP_VARIABLE_ITALIC = "_php_variable_italic";//$NON-NLS-1$
256
257         public static final String PHP_VARIABLE_UNDERLINE = "_php_variable_underline";//$NON-NLS-1$
258
259         public static final String PHP_VARIABLE_DOLLAR = "_php_variable_dollar";//$NON-NLS-1$
260
261         public static final String PHP_VARIABLE_DOLLAR_BOLD = "_php_variable_dollar_bold";//$NON-NLS-1$
262
263         public static final String PHP_VARIABLE_DOLLAR_ITALIC = "_php_variable_dollar_italic";//$NON-NLS-1$
264
265         public static final String PHP_VARIABLE_DOLLAR_UNDERLINE = "_php_variable_dollar_underline";//$NON-NLS-1$
266
267         public static final String PHP_TYPE = "_php_type";//$NON-NLS-1$
268
269         public static final String PHP_TYPE_BOLD = "_php_type_bold";//$NON-NLS-1$
270
271         public static final String PHP_TYPE_ITALIC = "_php_type_italic";//$NON-NLS-1$
272
273         public static final String PHP_TYPE_UNDERLINE = "_php_type_underline";//$NON-NLS-1$
274
275         public static final String PHP_CONSTANT = "_php_constant";//$NON-NLS-1$
276
277         public static final String PHP_CONSTANT_BOLD = "_php_constant_bold";//$NON-NLS-1$
278
279         public static final String PHP_CONSTANT_ITALIC = "_php_constant_italic";//$NON-NLS-1$
280
281         public static final String PHP_CONSTANT_UNDERLINE = "_php_constant_underline";//$NON-NLS-1$
282
283         public static final String PHP_FUNCTIONNAME = "_php_functionname";//$NON-NLS-1$
284
285         public static final String PHP_FUNCTIONNAME_BOLD = "_php_functionname_bold";//$NON-NLS-1$
286
287         public static final String PHP_FUNCTIONNAME_ITALIC = "_php_functionname_italic";//$NON-NLS-1$
288
289         public static final String PHP_FUNCTIONNAME_UNDERLINE = "_php_functionname_underline";//$NON-NLS-1$
290
291         public static final String PHP_STRING_DQ = "_php_string";//$NON-NLS-1$
292
293         public static final String PHP_STRING_BOLD_DQ = "_php_string_bold";
294
295         public static final String PHP_STRING_ITALIC_DQ = "_php_string_italic";
296
297         public static final String PHP_STRING_UNDERLINE_DQ = "_php_string_underline";
298
299         public static final String PHP_STRING_SQ = "_php_string_sq";//$NON-NLS-1$
300
301         public static final String PHP_STRING_BOLD_SQ = "_php_string_sq_bold";
302
303         public static final String PHP_STRING_ITALIC_SQ = "_php_string_sq_italic";
304
305         public static final String PHP_STRING_UNDERLINE_SQ = "_php_string_sq_underline";
306
307         public static final String PHP_DEFAULT = "_php_default";
308
309         public static final String PHP_DEFAULT_BOLD = "_php_default_bold";
310
311         public static final String PHP_DEFAULT_ITALIC = "_php_default_italic";
312
313         public static final String PHP_DEFAULT_UNDERLINE = "_php_default_underline";
314
315         public static final String TASK_TAG = "_php_comment_task_tag"; //$NON-NLS-1$
316
317         public static final String TASK_TAG_BOLD = "_php_comment_task_tag_bold"; //$NON-NLS-1$
318
319         /**
320          * The color key for PHPDoc keywords (<code>@foo</code>) in PHPDoc comments.
321          */
322         public static final String PHPDOC_KEYWORD = "_php_doc_keyword"; //$NON-NLS-1$
323
324         public static final String PHPDOC_KEYWORD_BOLD = "_php_doc_keyword_bold";
325
326         public static final String PHPDOC_KEYWORD_ITALIC = "_php_doc_keyword_italic";
327
328         public static final String PHPDOC_KEYWORD_UNDERLINE = "_php_doc_keyword_underline";
329
330         /**
331          * The color key for HTML tags (<code>&lt;foo&gt;</code>) in PHPDoc
332          * comments.
333          */
334         public static final String PHPDOC_TAG = "_php_doc_tag"; //$NON-NLS-1$
335
336         public static final String PHPDOC_TAG_BOLD = "_php_doc_tag_bold";
337
338         public static final String PHPDOC_TAG_ITALIC = "_php_doc_tag_italic";
339
340         public static final String PHPDOC_TAG_UNDERLINE = "_php_doc_tag_underline";
341
342         /**
343          * The color key for PHPDoc links (<code>{foo}</code>) in PHPDoc
344          * comments.
345          */
346         public static final String PHPDOC_LINK = "_php_doc_link"; //$NON-NLS-1$
347
348         public static final String PHPDOC_LINK_BOLD = "_php_doc_link_bold";
349
350         public static final String PHPDOC_LINK_ITALIC = "_php_doc_link_italic";
351
352         public static final String PHPDOC_LINK_UNDERLINE = "_php_doc_link_underline";
353
354         /**
355          * The color key for everthing in PHPDoc comments for which no other color
356          * is specified.
357          */
358         public static final String PHPDOC_DEFAULT = "_php_doc_default"; //$NON-NLS-1$
359
360         public static final String PHPDOC_DEFAULT_BOLD = "_php_doc_default_bold";
361
362         public static final String PHPDOC_DEFAULT_ITALIC = "_php_doc_default_italic";
363
364         public static final String PHPDOC_DEFAULT_UNDERLINE = "_php_doc_default_underline";
365
366         // public static final String LINKED_POSITION_COLOR =
367         // "_linkedPositionColor";
368         // public static final String PHP_EDITOR_BACKGROUND =
369         // "_php_editor_background";
370         public static final String PHP_USERDEF_XMLFILE = "_userdef_xmlfile";
371
372         /** Preference key for showing the line number ruler */
373         // public final static String LINE_NUMBER_RULER = "_lineNumberRuler";
374         // //$NON-NLS-1$
375         /** Preference key for the foreground color of the line numbers */
376         // public final static String LINE_NUMBER_COLOR = "_lineNumberColor";
377         // //$NON-NLS-1$
378         // public final static String PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT =
379         // "_defaultBackgroundColor"; //$NON-NLS-1$
380         // public final static String PREFERENCE_COLOR_BACKGROUND =
381         // "backgroundColor"; //$NON-NLS-1$
382         /** Preference key for content assist proposal color */
383         public final static String PROPOSALS_FOREGROUND = "content_assist_proposals_foreground"; //$NON-NLS-1$
384
385         /** Preference key for content assist proposal color */
386         public final static String PROPOSALS_BACKGROUND = "content_assist_proposals_background"; //$NON-NLS-1$
387
388         public static final String EDITOR_EVALUTE_TEMPORARY_PROBLEMS = null;
389
390         public static final String EDITOR_CORRECTION_INDICATION = null;
391
392         // public static final String PHP_OBFUSCATOR_DEFAULT =
393         // "_php_obfuscator_default";
394         // public static final String PHP_BOOKMARK_DEFAULT =
395         // "_php_bookmark_default";
396         // public static final String PHP_LOCALHOST_PREF = "_php_localhost";
397         // public static final String PHP_DOCUMENTROOT_PREF = "_php_documentroot";
398         //
399         // public static final String PHP_AUTO_PREVIEW_DEFAULT = "_auto_preview";
400         // public static final String PHP_BRING_TO_TOP_PREVIEW_DEFAULT =
401         // "_bring_to_top_preview";
402         // public static final String PHP_SHOW_HTML_FILES_LOCAL =
403         // "_show_html_files_local";
404 }