diff dwt/browser/ProgressListener.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/ProgressListener.d	Sat Aug 09 17:00:02 2008 +0200
@@ -0,0 +1,68 @@
+/*******************************************************************************
+ * 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.ProgressListener;
+
+import dwt.browser.ProgressEvent;
+import dwt.dwthelper.utils;
+import dwt.internal.DWTEventListener;
+
+/**
+ * This listener interface may be implemented in order to receive
+ * a {@link ProgressEvent} notification when a {@link Browser}
+ * makes a progress in loading the current URL or when the
+ * current URL has been loaded.
+ * 
+ * @see Browser#addProgressListener(ProgressListener)
+ * @see Browser#removeProgressListener(ProgressListener)
+ * @see Browser#getUrl()
+ * 
+ * @since 3.0
+ */
+public interface ProgressListener : DWTEventListener {
+
+    /**
+     * This method is called when a progress is made during the loading of the 
+     * current location.
+     * <p>
+     *
+     * <p>The following fields in the <code>ProgressEvent</code> apply:
+     * <ul>
+     * <li>(in) current the progress for the location currently being loaded
+     * <li>(in) total the maximum progress for the location currently being loaded
+     * <li>(in) widget the <code>Browser</code> whose current URL is being loaded
+     * </ul>
+     * 
+     * @param event the <code>ProgressEvent</code> related to the loading of the
+     * current location of a <code>Browser</code>
+     * 
+     * @since 3.0
+     */
+    public void changed (ProgressEvent event);
+
+    /**
+     * This method is called when the current location has been completely loaded.
+     * <p>
+     *
+     * <p>The following fields in the <code>ProgressEvent</code> apply:
+     * <ul>
+     * <li>(in) widget the <code>Browser</code> whose current URL has been loaded
+     * </ul>
+     * 
+     * @param event the <code>ProgressEvent</code> related to the <code>Browser</code>
+     * that has loaded its current URL.
+     * 
+     * @since 3.0
+     */
+    public void completed (ProgressEvent event);
+}