comparison dwt/browser/OpenWindowListener.d @ 125:5583f8eeee6c

Synced mozilla with dwt-linux
author Jacob Carlborg <doob@me.com>
date Fri, 16 Jan 2009 12:49:08 +0100
parents d8635bb48c7c
children
comparison
equal deleted inserted replaced
124:540fa4e9974a 125:5583f8eeee6c
5 * which accompanies this distribution, and is available at 5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html 6 * http://www.eclipse.org/legal/epl-v10.html
7 * 7 *
8 * Contributors: 8 * Contributors:
9 * IBM Corporation - initial API and implementation 9 * IBM Corporation - initial API and implementation
10 *
11 * Port to the D programming language: 10 * Port to the D programming language:
12 * Jacob Carlborg <doob@me.com> 11 * John Reimer <terminal.node@gmail.com>
13 *******************************************************************************/ 12 *******************************************************************************/
14 module dwt.browser.OpenWindowListener; 13 module dwt.browser.OpenWindowListener;
15 14
15 import dwt.internal.DWTEventListener;
16 import dwt.browser.WindowEvent; 16 import dwt.browser.WindowEvent;
17 import dwt.dwthelper.utils;
18 import dwt.internal.DWTEventListener;
19 17
20 /** 18 /**
21 * This listener interface may be implemented in order to receive 19 * This listener interface may be implemented in order to receive
22 * a {@link WindowEvent} notification when a new {@link Browser} 20 * a {@link WindowEvent} notification when a new {@link Browser}
23 * needs to be provided by the application. 21 * needs to be provided by the application.
29 * 27 *
30 * @since 3.0 28 * @since 3.0
31 */ 29 */
32 public interface OpenWindowListener : DWTEventListener { 30 public interface OpenWindowListener : DWTEventListener {
33 31
34 /** 32 /**
35 * This method is called when a new window needs to be created. 33 * This method is called when a new window needs to be created.
36 * <p> 34 * <p>
37 * A particular <code>Browser</code> can be passed to the event.browser 35 * A particular <code>Browser</code> can be passed to the event.browser
38 * field to host the content of a new window. 36 * field to host the content of a new window.
39 * <p> 37 * <p>
40 * A standalone system browser is used to host the new window 38 * A standalone system browser is used to host the new window
41 * if the event.required field value is false and if the event.browser 39 * if the event.required field value is false and if the event.browser
42 * field is left <code>null</code>. The event.required field 40 * field is left <code>null</code>. The event.required field
43 * is true on platforms that don't support a standalone system browser for 41 * is true on platforms that don't support a standalone system browser for
44 * new window requests. 42 * new window requests.
45 * <p> 43 * <p>
46 * The navigation is cancelled if the event.required field is set to 44 * The navigation is cancelled if the event.required field is set to
47 * true and the event.browser field is left <code>null</code>. 45 * true and the event.browser field is left <code>null</code>.
48 * <p> 46 * <p>
49 * <p>The following fields in the <code>WindowEvent</code> apply: 47 * <p>The following fields in the <code>WindowEvent</code> apply:
50 * <ul> 48 * <ul>
51 * <li>(in/out) required true if the platform requires the user to provide a 49 * <li>(in/out) required true if the platform requires the user to provide a
52 * <code>Browser</code> to handle the new window or false otherwise. 50 * <code>Browser</code> to handle the new window or false otherwise.
53 * <li>(out) browser the new <code>Browser</code> that will host the 51 * <li>(out) browser the new <code>Browser</code> that will host the
54 * content of the new window. 52 * content of the new window.
55 * <li>(in) widget the <code>Browser</code> that is requesting to open a 53 * <li>(in) widget the <code>Browser</code> that is requesting to open a
56 * new window 54 * new window
57 * </ul> 55 * </ul>
58 * 56 *
59 * @param event the <code>WindowEvent</code> that needs to be passed a new 57 * @param event the <code>WindowEvent</code> that needs to be passed a new
60 * <code>Browser</code> to handle the new window request 58 * <code>Browser</code> to handle the new window request
61 * 59 *
62 * @since 3.0 60 * @since 3.0
63 */ 61 */
64 public void open (WindowEvent event); 62 public void open(WindowEvent event);
65 } 63 }