d6de39e419f6ff27004002ac9c9636412479d953
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpdt / ui / text / IJavaColorConstants.java
1 /*******************************************************************************
2  * Copyright (c) 2000, 2002 International Business Machines 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 API and implementation
10  ******************************************************************************/
11 package net.sourceforge.phpdt.ui.text;
12
13 /**
14  * Color keys used for syntax highlighting PHP 
15  * code and PHPDoc compliant comments. 
16  * A <code>IColorManager</code> is responsible for mapping 
17  * concrete colors to these keys.
18  * <p>
19  * This interface declares static final fields only; it is not intended to be 
20  * implemented.
21  * </p>
22  *
23  * @see IColorManager
24  */
25 public interface IJavaColorConstants {
26         
27         /** 
28          * Note: This constant is for internal use only. Clients should not use this constant.
29          * The prefix all color constants start with.
30          */
31         String PREFIX= "php_"; //$NON-NLS-1$
32         
33         /** The color key for multi-line comments in PHP code. */
34         String PHP_MULTI_LINE_COMMENT= "php_multi_line_comment"; //$NON-NLS-1$
35         /** The color key for single-line comments in PHP code. */
36         String PHP_SINGLE_LINE_COMMENT= "php_single_line_comment"; //$NON-NLS-1$
37         /** The color key for PHP keywords in PHP code. */
38         String PHP_KEYWORD= "php_keyword"; //$NON-NLS-1$
39         /** The color key for string and character literals in PHP code. */
40         String PHP_STRING= "php_string"; //$NON-NLS-1$
41         /** The color key for everthing in PHP code for which no other color is specified. */
42         String PHP_DEFAULT= "php_default"; //$NON-NLS-1$
43   /** The color key for predefined PHP function namesin PHP code. */
44   String PHP_FUNCTIONNAME= "php_functionname"; //$NON-NLS-1$
45   /** The color key for ($-)variables in PHP code. */
46   String PHP_VARIABLE= "php_variable"; //$NON-NLS-1$
47   /** The color key for constants in PHP code */
48   String PHP_CONSTANT= "php_constant"; //$NON-NLS-1$
49         /** The color key for the PHP built-in types in PHP code. */
50         String PHP_TYPE= "php_type"; //$NON-NLS-1$
51         
52         
53         /** The color key for PHPDoc keywords (<code>@foo</code>) in PHPDoc comments. */
54         String PHPDOC_KEYWORD= "php_doc_keyword"; //$NON-NLS-1$
55         /** The color key for HTML tags (<code>&lt;foo&gt;</code>) in PHPDoc comments. */
56         String PHPDOC_TAG= "php_doc_tag"; //$NON-NLS-1$
57         /** The color key for PHPDoc links (<code>{foo}</code>) in PHPDoc comments. */
58         String PHPDOC_LINK= "php_doc_link"; //$NON-NLS-1$
59         /** The color key for everthing in PHPDoc comments for which no other color is specified. */
60         String PHPDOC_DEFAULT= "php_doc_default"; //$NON-NLS-1$
61 }