new feature module
[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     Klaus Hartlage - www.eclipseproject.de
11 **********************************************************************/
12 package net.sourceforge.phpeclipse;
13
14
15
16 /**
17  * Predefined prference constants
18  */
19 public interface IPreferenceConstants {
20         /**
21          * Preference key suffix for bold text style preference keys.
22          * 
23          * @since 2.1
24          */
25         public static final String EDITOR_BOLD_SUFFIX= "_bold"; //$NON-NLS-1$
26
27         /**
28          * Preference key suffix for italic text style preference keys.
29          * 
30          * @since 3.0
31          */
32         public static final String EDITOR_ITALIC_SUFFIX= "_italic"; //$NON-NLS-1$
33         
34 //  public static final String LOCALHOST_PREF = "_localhost";
35 //  public static final String DOCUMENTROOT_PREF = "_documentroot";
36   public static final String USE_EXTERNAL_BROWSER_PREF = "_use_external_browser";
37 //  public static final String SHOW_EXTERNAL_PREVIEW_PREF = "_show_external_preview";
38   public static final String EXTERNAL_BROWSER_PREF = "_external_browser";
39   public static final String MYSQL_RUN_PREF = "_mysql_run_pref";
40   public static final String MYSQL_START_BACKGROUND = "_mysql_start_background";
41   public static final String MYSQL_PREF = "__mysql_start";
42   public static final String APACHE_RUN_PREF = "_apache_run_pref";
43   public static final String APACHE_START_BACKGROUND = "_apache_start_background";
44   public static final String APACHE_START_PREF = "__apache_start";
45   public static final String APACHE_STOP_BACKGROUND = "_apache_stop_background";
46   public static final String APACHE_STOP_PREF = "__apache_stop";
47   public static final String APACHE_RESTART_BACKGROUND = "_apache_restart_background";
48   public static final String APACHE_RESTART_PREF = "__apache_restart";
49   public static final String SHOW_OUTPUT_IN_CONSOLE = "_show_output_in_console";
50   public static final String PHP_RUN_PREF = "_php_run_pref";
51   public static final String EXTERNAL_PARSER_PREF = "_external_parser";
52   public static final String PHP_PARSER_DEFAULT = "_php_parser_default";
53 //  public static final String PHP_INTERNAL_PARSER = "_php_internal_parser";
54 //  public static final String PHP_EXTERNAL_PARSER = "_php_external_parser";
55   // public static final String PHP_PARSE_ON_SAVE = "_php_parse_on_save";
56   public static final String PHP_MULTILINE_COMMENT = "_php_multilineComment";
57   public static final String PHP_MULTILINE_COMMENT_BOLD = "_php_multilineComment_bold";
58   public static final String PHP_MULTILINE_COMMENT_ITALIC = "_php_multilineComment_italic";
59   public static final String PHP_MULTILINE_COMMENT_UNDERLINE = "_php_multilineComment_underline";
60   /** The color key for operators and brackets in PHP code
61          * (value <code>"__php_operator"</code>).
62          * @since 3.0
63          */
64   public static final String PHP_OPERATOR = "__php_operator"; //$NON-NLS-1$
65   
66   /** The color key for {} in PHP code
67          * (value <code>"__php_brace_operator"</code>).
68          * @since 3.0
69          */
70   public static final String PHP_BRACE_OPERATOR = "__php_brace_operator"; //$NON-NLS-1$
71
72   /**
73          * A named preference that holds the color used to render operators and brackets.
74          * <p>
75          * Value is of type <code>String</code>. A RGB color value encoded as a string
76          * using class <code>PreferenceConverter</code>
77          * </p>
78          * 
79          * @see org.eclipse.jface.resource.StringConverter
80          * @see org.eclipse.jface.preference.PreferenceConverter
81          * @since 3.0
82          */
83         public final static String EDITOR_PHP_OPERATOR_COLOR= PHP_OPERATOR;     
84
85         /**
86          * A named preference that controls whether operators and brackets are rendered in bold.
87          * <p>
88          * Value is of type <code>Boolean</code>.
89          * </p>
90          * 
91          * @since 3.0
92          */
93         public final static String EDITOR_PHP_OPERATOR_BOLD= PHP_OPERATOR + EDITOR_BOLD_SUFFIX;
94         
95         /**
96          * A named preference that controls whether operators and brackets are rendered in italic.
97          * <p>
98          * Value is of type <code>Boolean</code>.
99          * </p>
100          * 
101          * @since 3.0
102          */
103         public final static String EDITOR_PHP_OPERATOR_ITALIC= PHP_OPERATOR + EDITOR_ITALIC_SUFFIX;
104
105         /**
106          * A named preference that holds the color used to render operators and brackets.
107          * <p>
108          * Value is of type <code>String</code>. A RGB color value encoded as a string
109          * using class <code>PreferenceConverter</code>
110          * </p>
111          * 
112          * @see org.eclipse.jface.resource.StringConverter
113          * @see org.eclipse.jface.preference.PreferenceConverter
114          * @since 3.0
115          */
116         public final static String EDITOR_PHP_BRACE_OPERATOR_COLOR= PHP_BRACE_OPERATOR; 
117
118         /**
119          * A named preference that controls whether operators and brackets are rendered in bold.
120          * <p>
121          * Value is of type <code>Boolean</code>.
122          * </p>
123          * 
124          * @since 3.0
125          */
126         public final static String EDITOR_PHP_BRACE_OPERATOR_BOLD= PHP_BRACE_OPERATOR + EDITOR_BOLD_SUFFIX;
127         
128         /**
129          * A named preference that controls whether operators and brackets are rendered in italic.
130          * <p>
131          * Value is of type <code>Boolean</code>.
132          * </p>
133          * 
134          * @since 3.0
135          */
136         public final static String EDITOR_PHP_BRACE_OPERATOR_ITALIC= PHP_BRACE_OPERATOR + EDITOR_ITALIC_SUFFIX;
137
138   /** The color key for keyword 'return' in PHP code
139          * (value <code>"__php_keyword_return"</code>).
140          * @since 3.0
141          */
142   public static final String PHP_KEYWORD_RETURN= "__php_keyword_return"; //$NON-NLS-1$
143   /**
144          * A named preference that holds the color used to render the 'return' keyword.
145          * <p>
146          * Value is of type <code>String</code>. A RGB color value encoded as a string
147          * using class <code>PreferenceConverter</code>
148          * </p>
149          * 
150          * @see org.eclipse.jface.resource.StringConverter
151          * @see org.eclipse.jface.preference.PreferenceConverter
152          * @since 3.0
153          */
154         public final static String EDITOR_PHP_KEYWORD_RETURN_COLOR= PHP_KEYWORD_RETURN; 
155
156         /**
157          * A named preference that controls whether 'return' keyword is rendered in bold.
158          * <p>
159          * Value is of type <code>Boolean</code>.
160          * </p>
161          * 
162          * @since 3.0
163          */
164         public final static String EDITOR_PHP_KEYWORD_RETURN_BOLD= PHP_KEYWORD_RETURN + EDITOR_BOLD_SUFFIX;
165         
166         /**
167          * A named preference that controls whether 'return' keyword is rendered in italic.
168          * <p>
169          * Value is of type <code>Boolean</code>.
170          * </p>
171          * 
172          * @since 3.0
173          */
174         public final static String EDITOR_PHP_KEYWORD_RETURN_ITALIC= PHP_KEYWORD_RETURN + EDITOR_ITALIC_SUFFIX;
175         
176         public static final String PHP_SINGLELINE_COMMENT = "_php_singlelineComment";  
177   public static final String PHP_SINGLELINE_COMMENT_BOLD = "_php_singlelineComment_bold";//$NON-NLS-1$
178   public static final String PHP_SINGLELINE_COMMENT_ITALIC = "_php_singlelineComment_italic";//$NON-NLS-1$
179   public static final String PHP_SINGLELINE_COMMENT_UNDERLINE = "_php_singlelineComment_underline";//$NON-NLS-1$
180   public static final String PHP_TAG = "_php_tag";//$NON-NLS-1$
181   public static final String PHP_TAG_BOLD = "_php_tag_bold";//$NON-NLS-1$
182   public static final String PHP_TAG_ITALIC = "_php_tag_italic";//$NON-NLS-1$
183   public static final String PHP_TAG_UNDERLINE = "_php_tag_underline";//$NON-NLS-1$
184   public static final String PHP_KEYWORD = "_php_keyword";//$NON-NLS-1$
185   public static final String PHP_KEYWORD_BOLD = "_php_keyword_bold";//$NON-NLS-1$
186   public static final String PHP_KEYWORD_ITALIC = "_php_keyword_italic";//$NON-NLS-1$
187   public static final String PHP_KEYWORD_UNDERLINE = "_php_keyword_underline";//$NON-NLS-1$
188   public static final String PHP_VARIABLE = "_php_variable";//$NON-NLS-1$
189   public static final String PHP_VARIABLE_BOLD = "_php_variable_bold";//$NON-NLS-1$
190   public static final String PHP_VARIABLE_ITALIC = "_php_variable_italic";//$NON-NLS-1$
191   public static final String PHP_VARIABLE_UNDERLINE = "_php_variable_underline";//$NON-NLS-1$
192   public static final String PHP_TYPE = "_php_type";//$NON-NLS-1$
193   public static final String PHP_TYPE_BOLD = "_php_type_bold";//$NON-NLS-1$
194   public static final String PHP_TYPE_ITALIC = "_php_type_italic";//$NON-NLS-1$
195   public static final String PHP_TYPE_UNDERLINE = "_php_type_underline";//$NON-NLS-1$
196   public static final String PHP_CONSTANT = "_php_constant";//$NON-NLS-1$
197   public static final String PHP_CONSTANT_BOLD = "_php_constant_bold";//$NON-NLS-1$
198   public static final String PHP_CONSTANT_ITALIC = "_php_constant_italic";//$NON-NLS-1$
199   public static final String PHP_CONSTANT_UNDERLINE = "_php_constant_underline";//$NON-NLS-1$
200   public static final String PHP_FUNCTIONNAME = "_php_functionname";//$NON-NLS-1$
201   public static final String PHP_FUNCTIONNAME_BOLD = "_php_functionname_bold";//$NON-NLS-1$
202   public static final String PHP_FUNCTIONNAME_ITALIC = "_php_functionname_italic";//$NON-NLS-1$
203   public static final String PHP_FUNCTIONNAME_UNDERLINE = "_php_functionname_underline";//$NON-NLS-1$
204   public static final String PHP_STRING = "_php_string";//$NON-NLS-1$
205   public static final String PHP_STRING_BOLD = "_php_string_bold";
206   public static final String PHP_STRING_ITALIC = "_php_string_italic";
207   public static final String PHP_STRING_UNDERLINE = "_php_string_underline";
208   public static final String PHP_DEFAULT = "_php_default";
209   public static final String PHP_DEFAULT_BOLD = "_php_default_bold";
210   public static final String PHP_DEFAULT_ITALIC = "_php_default_italic";
211   public static final String PHP_DEFAULT_UNDERLINE = "_php_default_underline";
212   public static final String TASK_TAG= "_php_comment_task_tag"; //$NON-NLS-1$
213   public static final String TASK_TAG_BOLD = "_php_comment_task_tag_bold"; //$NON-NLS-1$
214         
215   /** The color key for PHPDoc keywords (<code>@foo</code>) in PHPDoc comments. */
216   public static final String PHPDOC_KEYWORD = "_php_doc_keyword"; //$NON-NLS-1$
217   public static final String PHPDOC_KEYWORD_BOLD = "_php_doc_keyword_bold";
218   public static final String PHPDOC_KEYWORD_ITALIC = "_php_doc_keyword_italic";
219   public static final String PHPDOC_KEYWORD_UNDERLINE = "_php_doc_keyword_underline";
220   /** The color key for HTML tags (<code>&lt;foo&gt;</code>) in PHPDoc comments. */
221   public static final String PHPDOC_TAG = "_php_doc_tag"; //$NON-NLS-1$
222   public static final String PHPDOC_TAG_BOLD = "_php_doc_tag_bold";
223   public static final String PHPDOC_TAG_ITALIC = "_php_doc_tag_italic";
224   public static final String PHPDOC_TAG_UNDERLINE = "_php_doc_tag_underline";
225   /** The color key for PHPDoc links (<code>{foo}</code>) in PHPDoc comments. */
226   public static final String PHPDOC_LINK = "_php_doc_link"; //$NON-NLS-1$
227   public static final String PHPDOC_LINK_BOLD = "_php_doc_link_bold";
228   public static final String PHPDOC_LINK_ITALIC = "_php_doc_link_italic";
229   public static final String PHPDOC_LINK_UNDERLINE = "_php_doc_link_underline";
230   /** The color key for everthing in PHPDoc comments for which no other color is specified. */
231   public static final String PHPDOC_DEFAULT = "_php_doc_default"; //$NON-NLS-1$
232   public static final String PHPDOC_DEFAULT_BOLD = "_php_doc_default_bold";
233   public static final String PHPDOC_DEFAULT_ITALIC = "_php_doc_default_italic";
234   public static final String PHPDOC_DEFAULT_UNDERLINE = "_php_doc_default_underline";
235
236   //  public static final String LINKED_POSITION_COLOR = "_linkedPositionColor";
237   //  public static final String PHP_EDITOR_BACKGROUND = "_php_editor_background";
238   public static final String PHP_USERDEF_XMLFILE = "_userdef_xmlfile";
239
240   /** Preference key for showing the line number ruler */
241   // public final static String LINE_NUMBER_RULER = "_lineNumberRuler"; //$NON-NLS-1$
242   /** Preference key for the foreground color of the line numbers */
243   // public final static String LINE_NUMBER_COLOR = "_lineNumberColor"; //$NON-NLS-1$
244
245   //  public final static String PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT = "_defaultBackgroundColor"; //$NON-NLS-1$
246   //  public final static String PREFERENCE_COLOR_BACKGROUND = "backgroundColor"; //$NON-NLS-1$
247
248   /** Preference key for content assist proposal color */
249   public final static String PROPOSALS_FOREGROUND = "content_assist_proposals_foreground"; //$NON-NLS-1$
250   /** Preference key for content assist proposal color */
251   public final static String PROPOSALS_BACKGROUND = "content_assist_proposals_background"; //$NON-NLS-1$
252   public static final String EDITOR_EVALUTE_TEMPORARY_PROBLEMS = null;
253   public static final String EDITOR_CORRECTION_INDICATION = null;
254
255   public static final String PHP_OBFUSCATOR_DEFAULT = "_php_obfuscator_default";
256 //  public static final String PHP_BOOKMARK_DEFAULT = "_php_bookmark_default";
257 //  public static final String PHP_LOCALHOST_PREF = "_php_localhost";
258 //  public static final String PHP_DOCUMENTROOT_PREF = "_php_documentroot";
259 //  
260 //  public static final String PHP_AUTO_PREVIEW_DEFAULT = "_auto_preview";
261 //  public static final String PHP_BRING_TO_TOP_PREVIEW_DEFAULT = "_bring_to_top_preview";
262 //  public static final String PHP_SHOW_HTML_FILES_LOCAL = "_show_html_files_local";
263 }