view dwtx/jface/text/contentassist/ICompletionProposalExtension6.d @ 129:eb30df5ca28b

Added JFace Text sources
author Frank Benoit <benoit@tionex.de>
date Sat, 23 Aug 2008 19:10:48 +0200
parents
children c4fb132a086c
line wrap: on
line source

/*******************************************************************************
 * Copyright (c) 2008 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.text.contentassist.ICompletionProposalExtension6;

import dwt.dwthelper.utils;

import dwtx.jface.viewers.StyledString;


/**
 * Extends {@link dwtx.jface.text.contentassist.ICompletionProposal} with the following
 * function:
 * <ul>
 *  <li>Allow styled ranges in the display string.</li>
 * </ul>
 * 
 * @since 3.4
 */
public interface ICompletionProposalExtension6 {
    
    /**
     * Returns the styled string used to display this proposal in the list of completion proposals.
     * This can for example be used to draw mixed colored labels.
     * <p>
     * <strong>Note:</strong> {@link ICompletionProposal#getDisplayString()} still needs to be
     * correctly implemented as this method might be ignored in case of uninstalled owner draw
     * support.
     * </p>
     * 
     * @return the string builder used to display this proposal
     */
    StyledString getStyledDisplayString();
}