view dwtx/jface/text/quickassist/IQuickAssistAssistantExtension.d @ 131:c4fb132a086c

Add package imports
author Frank Benoit <benoit@tionex.de>
date Sun, 24 Aug 2008 01:13:23 +0200
parents eb30df5ca28b
children
line wrap: on
line source

/*******************************************************************************
 * Copyright (c) 2007, 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.quickassist.IQuickAssistAssistantExtension;

import dwtx.jface.text.quickassist.QuickAssistAssistant; // packageimport
import dwtx.jface.text.quickassist.IQuickAssistAssistant; // packageimport
import dwtx.jface.text.quickassist.IQuickAssistInvocationContext; // packageimport
import dwtx.jface.text.quickassist.IQuickFixableAnnotation; // packageimport
import dwtx.jface.text.quickassist.IQuickAssistProcessor; // packageimport


import dwt.dwthelper.utils;


import dwtx.core.commands.IHandler;
import dwtx.jface.text.contentassist.ICompletionProposalExtension6;


/**
 * Extends {@link IQuickAssistAssistant} with the following function:
 * <ul>
 *  <li>allows to get a handler for the given command identifier</li>
 *  <li>allows to enable support for colored labels in the proposal popup</li>
 * </ul>
 * 
 * @since 3.4
 */
public interface IQuickAssistAssistantExtension {

    /**
     * Returns the handler for the given command identifier.
     * <p>
     * The same handler instance will be returned when called a more than once
     * with the same command identifier.
     * </p>
     * 
     * @param commandId the command identifier
     * @return the handler for the given command identifier
     * @throws IllegalArgumentException if the command is not supported by this
     *             content assistant
     * @throws IllegalStateException if called when this content assistant is
     *             uninstalled
     */
    IHandler getHandler(String commandId);

    /**
     * Enables the support for colored labels in the proposal popup.
     * <p>Completion proposals can implement {@link ICompletionProposalExtension6}
     * to provide colored proposal labels.</p>
     * 
     * @param isEnabled if <code>true</code> the support for colored labels is enabled in the proposal popup
     * @since 3.4
     */
    void enableColoredLabels(bool isEnabled);

}