annotate dwtx/jface/fieldassist/IContentProposalProvider.d @ 192:c3583c6ec027

Added missing default cases for switch statements
author Frank Benoit <benoit@tionex.de>
date Mon, 03 Nov 2008 22:52:26 +0100
parents f12d40e7da8f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2005, 2006 IBM Corporation and others.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.fieldassist.IContentProposalProvider;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwtx.jface.fieldassist.IContentProposal;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwt.dwthelper.utils;
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 /**
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * IContentProposalProvider provides an array of IContentProposals that are
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * appropriate for a textual dialog field, given the field's current content and
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * the current cursor position.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * @since 3.2
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 public interface IContentProposalProvider {
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 /**
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * Return an array of Objects representing the valid content proposals for a
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * field.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * @param contents
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * the current contents of the text field
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * @param position
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * the current position of the cursor in the contents
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 *
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * @return the array of {@link IContentProposal} that represent valid
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * proposals for the field.
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 */
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 IContentProposal[] getProposals(String contents, int position);
f12d40e7da8f fieldassist
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 }