Mercurial > projects > dwt-mac
diff dwt/browser/LocationListener.d @ 0:380af2bdd8e5
Upload of whole dwt tree
author | Jacob Carlborg <doob@me.com> <jacob.carlborg@gmail.com> |
---|---|
date | Sat, 09 Aug 2008 17:00:02 +0200 |
parents | |
children | f565d3a95c0a |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/dwt/browser/LocationListener.d Sat Aug 09 17:00:02 2008 +0200 @@ -0,0 +1,69 @@ +/******************************************************************************* + * Copyright (c) 2003, 2004 IBM Corporation and others. + * All rights reserved. This program and the accompanying materials + * are made available under the terms of the Eclipse Public License v1.0 + * which accompanies this distribution, and is available at + * http://www.eclipse.org/legal/epl-v10.html + * + * Contributors: + * IBM Corporation - initial API and implementation + * + * Port to the D Programming language: + * Jacob Carlborg <jacob.carlborg@gmail.com> + *******************************************************************************/ +module dwt.browser.LocationListener; + +import dwt.browser.LocationEvent; +import dwt.internal.DWTEventListener; + +/** + * This listener interface may be implemented in order to receive + * a {@link LocationEvent} notification when a {@link Browser} + * navigates to a different URL. + * + * @see Browser#addLocationListener(LocationListener) + * @see Browser#removeLocationListener(LocationListener) + * + * @since 3.0 + */ +public interface LocationListener : DWTEventListener { + + /** + * This method is called when the current location is about to be changed. + * <p> + * + * <p>The following fields in the <code>LocationEvent</code> apply: + * <ul> + * <li>(in) location the location to be loaded + * <li>(in) widget the <code>Browser</code> whose location is changing + * <li>(in/out) doit can be set to <code>false</code> to prevent the location + * from being loaded + * </ul> + * + * @param event the <code>LocationEvent</code> that specifies the location + * to be loaded by a <code>Browser</code> + * + * @since 3.0 + */ + public void changing (LocationEvent event); + + /** + * This method is called when the current location is changed. + * <p> + * + * <p>The following fields in the <code>LocationEvent</code> apply: + * <ul> + * <li>(in) location the current location + * <li>(in) top <code>true</code> if the location opens in the top frame or + * <code>false</code> otherwise + * <li>(in) widget the <code>Browser</code> whose location has changed + * </ul> + * + * @param event the <code>LocationEvent</code> that specifies the new + * location of a <code>Browser</code> + * + * @since 3.0 + */ + public void changed (LocationEvent event); + +}