view dwtx/jface/text/contentassist/ICompletionProposalExtension4.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) 2005 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.ICompletionProposalExtension4;

import dwt.dwthelper.utils;

/**
 * Extends
 * {@link dwtx.jface.text.contentassist.ICompletionProposal} with
 * the following functions:
 * <ul>
 *   <li>specify whether a proposal is automatically insertable</li>
 * </ul>
 * 
 * @since 3.1
 */
public interface ICompletionProposalExtension4 {

    /**
     * Returns <code>true</code> if the proposal may be automatically
     * inserted, <code>false</code> otherwise. Automatic insertion can
     * happen if the proposal is the only one being proposed, in which
     * case the content assistant may decide to not prompt the user with
     * a list of proposals, but simply insert the single proposal. A
     * proposal may veto this behavior by returning <code>false</code>
     * to a call to this method.
     * 
     * @return <code>true</code> if the proposal may be inserted
     *         automatically, <code>false</code> if not
     */
    bool isAutoInsertable();
}