a4c52bb95603feed0a762e4ed364a2256087ad16
[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          * A named preference that holds the color used to render operators and brackets.
67          * <p>
68          * Value is of type <code>String</code>. A RGB color value encoded as a string
69          * using class <code>PreferenceConverter</code>
70          * </p>
71          * 
72          * @see org.eclipse.jface.resource.StringConverter
73          * @see org.eclipse.jface.preference.PreferenceConverter
74          * @since 3.0
75          */
76         public final static String EDITOR_PHP_OPERATOR_COLOR= PHP_OPERATOR;     
77
78         /**
79          * A named preference that controls whether operators and brackets are rendered in bold.
80          * <p>
81          * Value is of type <code>Boolean</code>.
82          * </p>
83          * 
84          * @since 3.0
85          */
86         public final static String EDITOR_PHP_OPERATOR_BOLD= PHP_OPERATOR + EDITOR_BOLD_SUFFIX;
87         
88         /**
89          * A named preference that controls whether operators and brackets are rendered in italic.
90          * <p>
91          * Value is of type <code>Boolean</code>.
92          * </p>
93          * 
94          * @since 3.0
95          */
96         public final static String EDITOR_PHP_OPERATOR_ITALIC= PHP_OPERATOR + EDITOR_ITALIC_SUFFIX;
97
98   /** The color key for keyword 'return' in PHP code
99          * (value <code>"__php_keyword_return"</code>).
100          * @since 3.0
101          */
102   public static final String PHP_KEYWORD_RETURN= "__php_keyword_return"; //$NON-NLS-1$
103   /**
104          * A named preference that holds the color used to render the 'return' keyword.
105          * <p>
106          * Value is of type <code>String</code>. A RGB color value encoded as a string
107          * using class <code>PreferenceConverter</code>
108          * </p>
109          * 
110          * @see org.eclipse.jface.resource.StringConverter
111          * @see org.eclipse.jface.preference.PreferenceConverter
112          * @since 3.0
113          */
114         public final static String EDITOR_PHP_KEYWORD_RETURN_COLOR= PHP_KEYWORD_RETURN; 
115
116         /**
117          * A named preference that controls whether 'return' keyword is rendered in bold.
118          * <p>
119          * Value is of type <code>Boolean</code>.
120          * </p>
121          * 
122          * @since 3.0
123          */
124         public final static String EDITOR_PHP_KEYWORD_RETURN_BOLD= PHP_KEYWORD_RETURN + EDITOR_BOLD_SUFFIX;
125         
126         /**
127          * A named preference that controls whether 'return' keyword is rendered in italic.
128          * <p>
129          * Value is of type <code>Boolean</code>.
130          * </p>
131          * 
132          * @since 3.0
133          */
134         public final static String EDITOR_PHP_KEYWORD_RETURN_ITALIC= PHP_KEYWORD_RETURN + EDITOR_ITALIC_SUFFIX;
135         
136         public static final String PHP_SINGLELINE_COMMENT = "_php_singlelineComment";  
137   public static final String PHP_SINGLELINE_COMMENT_BOLD = "_php_singlelineComment_bold";//$NON-NLS-1$
138   public static final String PHP_SINGLELINE_COMMENT_ITALIC = "_php_singlelineComment_italic";//$NON-NLS-1$
139   public static final String PHP_SINGLELINE_COMMENT_UNDERLINE = "_php_singlelineComment_underline";//$NON-NLS-1$
140         public static final String PHP_TAG = "_php_tag";//$NON-NLS-1$
141         public static final String PHP_TAG_BOLD = "_php_tag_bold";//$NON-NLS-1$
142         public static final String PHP_TAG_ITALIC = "_php_tag_italic";//$NON-NLS-1$
143         public static final String PHP_TAG_UNDERLINE = "_php_tag_underline";//$NON-NLS-1$
144   public static final String PHP_KEYWORD = "_php_keyword";//$NON-NLS-1$
145   public static final String PHP_KEYWORD_BOLD = "_php_keyword_bold";//$NON-NLS-1$
146   public static final String PHP_KEYWORD_ITALIC = "_php_keyword_italic";//$NON-NLS-1$
147   public static final String PHP_KEYWORD_UNDERLINE = "_php_keyword_underline";//$NON-NLS-1$
148   public static final String PHP_VARIABLE = "_php_variable";//$NON-NLS-1$
149   public static final String PHP_VARIABLE_BOLD = "_php_variable_bold";//$NON-NLS-1$
150   public static final String PHP_VARIABLE_ITALIC = "_php_variable_italic";//$NON-NLS-1$
151   public static final String PHP_VARIABLE_UNDERLINE = "_php_variable_underline";//$NON-NLS-1$
152   public static final String PHP_TYPE = "_php_type";//$NON-NLS-1$
153   public static final String PHP_TYPE_BOLD = "_php_type_bold";//$NON-NLS-1$
154   public static final String PHP_TYPE_ITALIC = "_php_type_italic";//$NON-NLS-1$
155   public static final String PHP_TYPE_UNDERLINE = "_php_type_underline";//$NON-NLS-1$
156   public static final String PHP_CONSTANT = "_php_constant";//$NON-NLS-1$
157   public static final String PHP_CONSTANT_BOLD = "_php_constant_bold";//$NON-NLS-1$
158   public static final String PHP_CONSTANT_ITALIC = "_php_constant_italic";//$NON-NLS-1$
159   public static final String PHP_CONSTANT_UNDERLINE = "_php_constant_underline";//$NON-NLS-1$
160   public static final String PHP_FUNCTIONNAME = "_php_functionname";//$NON-NLS-1$
161   public static final String PHP_FUNCTIONNAME_BOLD = "_php_functionname_bold";//$NON-NLS-1$
162   public static final String PHP_FUNCTIONNAME_ITALIC = "_php_functionname_italic";//$NON-NLS-1$
163   public static final String PHP_FUNCTIONNAME_UNDERLINE = "_php_functionname_underline";//$NON-NLS-1$
164   public static final String PHP_STRING = "_php_string";//$NON-NLS-1$
165   public static final String PHP_STRING_BOLD = "_php_string_bold";
166   public static final String PHP_STRING_ITALIC = "_php_string_italic";
167   public static final String PHP_STRING_UNDERLINE = "_php_string_underline";
168   public static final String PHP_DEFAULT = "_php_default";
169   public static final String PHP_DEFAULT_BOLD = "_php_default_bold";
170   public static final String PHP_DEFAULT_ITALIC = "_php_default_italic";
171   public static final String PHP_DEFAULT_UNDERLINE = "_php_default_underline";
172   public static final String TASK_TAG= "_php_comment_task_tag"; //$NON-NLS-1$
173   public static final String TASK_TAG_BOLD = "_php_comment_task_tag_bold"; //$NON-NLS-1$
174         
175   /** The color key for PHPDoc keywords (<code>@foo</code>) in PHPDoc comments. */
176   public static final String PHPDOC_KEYWORD = "_php_doc_keyword"; //$NON-NLS-1$
177   public static final String PHPDOC_KEYWORD_BOLD = "_php_doc_keyword_bold";
178   public static final String PHPDOC_KEYWORD_ITALIC = "_php_doc_keyword_italic";
179   public static final String PHPDOC_KEYWORD_UNDERLINE = "_php_doc_keyword_underline";
180   /** The color key for HTML tags (<code>&lt;foo&gt;</code>) in PHPDoc comments. */
181   public static final String PHPDOC_TAG = "_php_doc_tag"; //$NON-NLS-1$
182   public static final String PHPDOC_TAG_BOLD = "_php_doc_tag_bold";
183   public static final String PHPDOC_TAG_ITALIC = "_php_doc_tag_italic";
184   public static final String PHPDOC_TAG_UNDERLINE = "_php_doc_tag_underline";
185   /** The color key for PHPDoc links (<code>{foo}</code>) in PHPDoc comments. */
186   public static final String PHPDOC_LINK = "_php_doc_link"; //$NON-NLS-1$
187   public static final String PHPDOC_LINK_BOLD = "_php_doc_link_bold";
188   public static final String PHPDOC_LINK_ITALIC = "_php_doc_link_italic";
189   public static final String PHPDOC_LINK_UNDERLINE = "_php_doc_link_underline";
190   /** The color key for everthing in PHPDoc comments for which no other color is specified. */
191   public static final String PHPDOC_DEFAULT = "_php_doc_default"; //$NON-NLS-1$
192   public static final String PHPDOC_DEFAULT_BOLD = "_php_doc_default_bold";
193   public static final String PHPDOC_DEFAULT_ITALIC = "_php_doc_default_italic";
194   public static final String PHPDOC_DEFAULT_UNDERLINE = "_php_doc_default_underline";
195
196   //  public static final String LINKED_POSITION_COLOR = "_linkedPositionColor";
197   //  public static final String PHP_EDITOR_BACKGROUND = "_php_editor_background";
198   public static final String PHP_USERDEF_XMLFILE = "_userdef_xmlfile";
199
200   /** Preference key for showing the line number ruler */
201   // public final static String LINE_NUMBER_RULER = "_lineNumberRuler"; //$NON-NLS-1$
202   /** Preference key for the foreground color of the line numbers */
203   // public final static String LINE_NUMBER_COLOR = "_lineNumberColor"; //$NON-NLS-1$
204
205   //  public final static String PREFERENCE_COLOR_BACKGROUND_SYSTEM_DEFAULT = "_defaultBackgroundColor"; //$NON-NLS-1$
206   //  public final static String PREFERENCE_COLOR_BACKGROUND = "backgroundColor"; //$NON-NLS-1$
207
208   /** Preference key for content assist proposal color */
209   public final static String PROPOSALS_FOREGROUND = "content_assist_proposals_foreground"; //$NON-NLS-1$
210   /** Preference key for content assist proposal color */
211   public final static String PROPOSALS_BACKGROUND = "content_assist_proposals_background"; //$NON-NLS-1$
212   public static final String EDITOR_EVALUTE_TEMPORARY_PROBLEMS = null;
213   public static final String EDITOR_CORRECTION_INDICATION = null;
214
215   public static final String PHP_OBFUSCATOR_DEFAULT = "_php_obfuscator_default";
216   public static final String PHP_BOOKMARK_DEFAULT = "_php_bookmark_default";
217   
218   public static final String PHP_AUTO_PREVIEW_DEFAULT = "_auto_preview";
219   public static final String PHP_BRING_TO_TOP_PREVIEW_DEFAULT = "_bring_to_top_preview";
220 }