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