Mercurial > projects > dwt2

comparison org.eclipse.jface/src/org/eclipse/jface/dialogs/IDialogPage.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) 2000, 2006 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.jface.dialogs.IDialogPage;
14
15
16 import org.eclipse.swt.graphics.Image;
17 import org.eclipse.swt.widgets.Composite;
18 import org.eclipse.swt.widgets.Control;
19 import org.eclipse.jface.resource.ImageDescriptor;
20
21 import java.lang.all;
22 import java.util.Set;
23
24 /**
25 * Interface for a page in a multi-page dialog.
26 */
27 public interface IDialogPage {
28 /**
29 * Creates the top level control for this dialog
30 * page under the given parent composite.
31 * <p>
32 * Implementors are responsible for ensuring that
33 * the created control can be accessed via <code>getControl</code>
34 * </p>
35 *
36 * @param parent the parent composite
37 */
38 public void createControl(Composite parent);
39
40 /**
41 * Disposes the SWT resources allocated by this
42 * dialog page.
43 */
44 public void dispose();
45
46 /**
47 * Returns the top level control for this dialog page.
48 * <p>
49 * May return <code>null</code> if the control
50 * has not been created yet.
51 * </p>
52 *
53 * @return the top level control or <code>null</code>
54 */
55 public Control getControl();
56
57 /**
58 * Returns this dialog page's description text.
59 *
60 * @return the description text for this dialog page,
61 * or <code>null</code> if none
62 */
63 public String getDescription();
64
65 /**
66 * Returns the current error message for this dialog page.
67 * May be <code>null</code> to indicate no error message.
68 * <p>
69 * An error message should describe some error state,
70 * as opposed to a message which may simply provide instruction
71 * or information to the user.
72 * </p>
73 *
74 * @return the error message, or <code>null</code> if none
75 */
76 public String getErrorMessage();
77
78 /**
79 * Returns this dialog page's image.
80 *
81 * @return the image for this dialog page, or <code>null</code>
82 * if none
83 */
84 public Image getImage();
85
86 /**
87 * Returns the current message for this wizard page.
88 * <p>
89 * A message provides instruction or information to the
90 * user, as opposed to an error message which should
91 * describe some error state.
92 * </p>
93 *
94 * @return the message, or <code>null</code> if none
95 */
96 public String getMessage();
97
98 /**
99 * Returns this dialog page's title.
100 *
101 * @return the title of this dialog page,
102 * or <code>null</code> if none
103 */
104 public String getTitle();
105
106 /**
107 * Notifies that help has been requested for this dialog page.
108 */
109 public void performHelp();
110
111 /**
112 * Sets this dialog page's description text.
113 *
114 * @param description the description text for this dialog
115 * page, or <code>null</code> if none
116 */
117 public void setDescription(String description);
118
119 /**
120 * Sets this dialog page's image.
121 *
122 * @param image the image for this dialog page,
123 * or <code>null</code> if none
124 */
125 public void setImageDescriptor(ImageDescriptor image);
126
127 /**
128 * Set this dialog page's title.
129 *
130 * @param title the title of this dialog page,
131 * or <code>null</code> if none
132 */
133 public void setTitle(String title);
134
135 /**
136 * Sets the visibility of this dialog page.
137 *
138 * @param visible <code>true</code> to make this page visible,
139 * and <code>false</code> to hide it
140 */
141 public void setVisible(bool visible);
142 }