1 /*******************************************************************************
2  * Copyright (c) 2003, 2004 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  *      John Reimer <terminal.node@gmail.com>
12  *******************************************************************************/
13 module org.eclipse.swt.browser.LocationListener;
14 
15 import java.lang.all;
16 
17 import org.eclipse.swt.internal.SWTEventListener;
18 import org.eclipse.swt.browser.LocationEvent;
19 
20 /**
21  * This listener interface may be implemented in order to receive
22  * a {@link LocationEvent} notification when a {@link Browser}
23  * navigates to a different URL.
24  * 
25  * @see Browser#addLocationListener(LocationListener)
26  * @see Browser#removeLocationListener(LocationListener)
27  * 
28  * @since 3.0
29  */
30 public interface LocationListener : SWTEventListener {
31 
32 /**
33  * This method is called when the current location is about to be changed.
34  * <p>
35  *
36  * <p>The following fields in the <code>LocationEvent</code> apply:
37  * <ul>
38  * <li>(in) location the location to be loaded
39  * <li>(in) widget the <code>Browser</code> whose location is changing
40  * <li>(in/out) doit can be set to <code>false</code> to prevent the location
41  * from being loaded 
42  * </ul>
43  * 
44  * @param event the <code>LocationEvent</code> that specifies the location
45  * to be loaded by a <code>Browser</code>
46  * 
47  * @since 3.0
48  */ 
49 public void changing(LocationEvent event);
50 
51 /**
52  * This method is called when the current location is changed.
53  * <p>
54  *
55  * <p>The following fields in the <code>LocationEvent</code> apply:
56  * <ul>
57  * <li>(in) location the current location
58  * <li>(in) top <code>true</code> if the location opens in the top frame or
59  * <code>false</code> otherwise
60  * <li>(in) widget the <code>Browser</code> whose location has changed
61  * </ul>
62  * 
63  * @param event the <code>LocationEvent</code> that specifies  the new
64  * location of a <code>Browser</code>
65  * 
66  * @since 3.0
67  */ 
68 public void changed(LocationEvent event);
69 
70 }