Mercurial > projects > dwt-addons

comparison dwtx/jface/dialogs/IDialogBlockedHandler.d @ 8:a3ff22a98bef

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Dialog
author Frank Benoit <benoit@tionex.de>
date Sat, 29 Mar 2008 01:25:27 +0100
parents
children
comparison
equal deleted inserted replaced
7:8a302fdb4140 8:a3ff22a98bef
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 dwtx.jface.dialogs.IDialogBlockedHandler;
14
15
16 import dwt.widgets.Shell;
17 import dwtx.core.runtime.IProgressMonitor;
18 import dwtx.core.runtime.IStatus;
19 import dwtx.jface.wizard.WizardDialog;
20
21 import dwt.dwthelper.utils;
22
23 /**
24 * The IDialogBlockedHandler is the handler used by
25 * JFace to provide extra information when a
26 * blocking has occured. There is one static instance
27 * of this class used by WizardDialog and ModalContext.
28 * @see dwtx.core.runtime.IProgressMonitorWithBlocking#clearBlocked()
29 * @see dwtx.core.runtime.IProgressMonitorWithBlocking#setBlocked(IStatus)
30 * @see WizardDialog
31 * @since 3.0
32 */
33 public interface IDialogBlockedHandler {
34 /**
35 * The blockage has been cleared. Clear the
36 * extra information and resume.
37 */
38 public void clearBlocked();
39
40 /**
41 * A blockage has occured. Show the blockage and
42 * forward any actions to blockingMonitor.
43 * <b>NOTE:</b> This will open any blocked notification immediately
44 * even if there is a modal shell open.
45 *
46 * @param parentShell The shell this is being sent from. If the parent
47 * shell is <code>null</code> the behavior will be the same as
48 * IDialogBlockedHandler#showBlocked(IProgressMonitor, IStatus, String)
49 *
50 * @param blocking The monitor to forward to. This is most
51 * important for calls to <code>cancel()</code>.
52 * @param blockingStatus The status that describes the blockage
53 * @param blockedName The name of the locked operation.
54 * @see IDialogBlockedHandler#showBlocked(IProgressMonitor, IStatus, String)
55 */
56 public void showBlocked(Shell parentShell, IProgressMonitor blocking,
57 IStatus blockingStatus, String blockedName);
58
59 /**
60 * A blockage has occured. Show the blockage when there is
61 * no longer any modal shells in the UI and forward any actions
62 * to blockingMonitor.
63 *
64 * <b>NOTE:</b> As no shell has been specified this method will
65 * not open any blocked notification until all other modal shells
66 * have been closed.
67 *
68 * @param blocking The monitor to forward to. This is most
69 * important for calls to <code>cancel()</code>.
70 * @param blockingStatus The status that describes the blockage
71 * @param blockedName The name of the locked operation.
72 */
73 public void showBlocked(IProgressMonitor blocking, IStatus blockingStatus,
74 String blockedName);
75 }