annotate dwtx/jface/dialogs/IPageChangeProvider.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 d1f4edab3f34
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwtx.jface.dialogs.IPageChangeProvider;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwtx.jface.dialogs.IPageChangedListener;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import dwt.dwthelper.utils;
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * Minimal interface to a page change provider. Used for dialogs which can
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * switch between multiple pages.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * @since 3.1
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 public interface IPageChangeProvider {
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * Returns the currently selected page in the dialog.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * @return the selected page in the dialog or <code>null</code> if none is
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * selected. The type may be domain specific. In
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * the JFace provided dialogs this will be an instance of
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * <code>IDialogPage</code>.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 Object getSelectedPage();
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * Adds a listener for page changes in this page change provider. Has no
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * effect if an identical listener is already registered.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * @param listener
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * a page changed listener
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 void addPageChangedListener(IPageChangedListener listener);
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 /**
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * Removes the given page change listener from this page change provider.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 * Has no effect if an identical listener is not registered.
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 *
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * @param listener
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * a page changed listener
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 */
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 void removePageChangedListener(IPageChangedListener listener);
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53
d1f4edab3f34 Page Change
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 }