Mercurial > projects > dwt2

comparison org.eclipse.ui.forms/src/org/eclipse/ui/forms/IMessage.d @ 12:bc29606a740c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added dwt-addons in original directory structure of eclipse.org
author Frank Benoit <benoit@tionex.de>
date Sat, 14 Mar 2009 18:23:29 +0100
parents
children
comparison
equal deleted inserted replaced
11:43904fec5dca 12:bc29606a740c
1 /*******************************************************************************
2 * Copyright (c) 2007 IBM Corporation and others.
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
7 *
8 * Contributors:
9 * IBM Corporation - initial API and implementation
10 * Port to the D programming language:
11 * Frank Benoit <benoit@tionex.de>
12 ******************************************************************************/
13 module org.eclipse.ui.forms.IMessage;
14
15 import org.eclipse.swt.widgets.Control;
16 import org.eclipse.jface.dialogs.IMessageProvider;
17
18 import java.lang.all;
19
20 /**
21 * This interface encapsulates a single message that can be shown in a form.
22 * Messages can be associated with controls, or be of a general nature.
23 *
24 * @see IMessageManager
25 * @since 3.3
26 */
27 public interface IMessage : IMessageProvider {
28 /**
29 * Returns the unique message key
30 *
31 * @return the unique message key
32 */
33 Object getKey();
34
35 /**
36 * Returns data for application use
37 *
38 * @return data object
39 */
40 Object getData();
41
42 /**
43 * Returns the control this message is associated with.
44 *
45 * @return the control or <code>null</code> if this is a general message.
46 */
47 Control getControl();
48
49 /**
50 * Messages that are associated with controls can be shown with a prefix
51 * that indicates the origin of the message (e.g. the label preceeding the
52 * control).
53 *
54 * @return the message prefix or <code>null</code> if this is a general
55 * message
56 */
57 String getPrefix();
58 }