comparison dwtx/jface/dialogs/IPageChangeProvider.d @ 20:d1f4edab3f34

Page Change
author Frank Benoit <benoit@tionex.de>
date Thu, 03 Apr 2008 00:33:43 +0200
parents
children
comparison
equal deleted inserted replaced
19:2b36428a5ce4 20:d1f4edab3f34
1 /*******************************************************************************
2 * Copyright (c) 2000, 2005 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 dwtx.jface.dialogs.IPageChangeProvider;
14
15 import dwtx.jface.dialogs.IPageChangedListener;
16
17 import dwt.dwthelper.utils;
18
19 /**
20 * Minimal interface to a page change provider. Used for dialogs which can
21 * switch between multiple pages.
22 *
23 * @since 3.1
24 */
25 public interface IPageChangeProvider {
26 /**
27 * Returns the currently selected page in the dialog.
28 *
29 * @return the selected page in the dialog or <code>null</code> if none is
30 * selected. The type may be domain specific. In
31 * the JFace provided dialogs this will be an instance of
32 * <code>IDialogPage</code>.
33 */
34 Object getSelectedPage();
35
36 /**
37 * Adds a listener for page changes in this page change provider. Has no
38 * effect if an identical listener is already registered.
39 *
40 * @param listener
41 * a page changed listener
42 */
43 void addPageChangedListener(IPageChangedListener listener);
44
45 /**
46 * Removes the given page change listener from this page change provider.
47 * Has no effect if an identical listener is not registered.
48 *
49 * @param listener
50 * a page changed listener
51 */
52 void removePageChangedListener(IPageChangedListener listener);
53
54 }