view dwtx/jface/viewers/IColorProvider.d @ 10:b6c35faf97c8

Viewers
author Frank Benoit <benoit@tionex.de>
date Mon, 31 Mar 2008 00:47:19 +0200
parents
children
line wrap: on
line source

/*******************************************************************************
 * Copyright (c) 2000, 2006 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 * Port to the D programming language:
 *     Frank Benoit <benoit@tionex.de>
 *******************************************************************************/

module dwtx.jface.viewers.IColorProvider;

import dwt.graphics.Color;

/**
 * Interface to provide color representation for a given element.
 * @see dwtx.jface.viewers.IColorDecorator
 */
public interface IColorProvider {

    /**
     * Provides a foreground color for the given element.
     * 
     * @param element the element
     * @return  the foreground color for the element, or <code>null</code> 
     *   to use the default foreground color
     */
    Color getForeground(Object element);

    /**
     * Provides a background color for the given element.
     * 
     * @param element the element
     * @return  the background color for the element, or <code>null</code> 
     *   to use the default background color
     */
    Color getBackground(Object element);
}