org.eclipse.swt.browser.ProgressListener source code

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.ProgressListener;
14 
15 import java.lang.all;
16 
17 import org.eclipse.swt.browser.ProgressEvent;
18 import org.eclipse.swt.internal.SWTEventListener;
19 
20 /**
21  * This listener interface may be implemented in order to receive
22  * a {@link ProgressEvent} notification when a {@link Browser}
23  * makes a progress in loading the current URL or when the
24  * current URL has been loaded.
25  * 
26  * @see Browser#addProgressListener(ProgressListener)
27  * @see Browser#removeProgressListener(ProgressListener)
28  * @see Browser#getUrl()
29  * 
30  * @since 3.0
31  */
32 public interface ProgressListener : SWTEventListener {
33     
34 /**
35  * This method is called when a progress is made during the loading of the 
36  * current location.
37  * <p>
38  *
39  * <p>The following fields in the <code>ProgressEvent</code> apply:
40  * <ul>
41  * <li>(in) current the progress for the location currently being loaded
42  * <li>(in) total the maximum progress for the location currently being loaded
43  * <li>(in) widget the <code>Browser</code> whose current URL is being loaded
44  * </ul>
45  * 
46  * @param event the <code>ProgressEvent</code> related to the loading of the
47  * current location of a <code>Browser</code>
48  * 
49  * @since 3.0
50  */   
51 public void changed(ProgressEvent event);
52     
53 /**
54  * This method is called when the current location has been completely loaded.
55  * <p>
56  *
57  * <p>The following fields in the <code>ProgressEvent</code> apply:
58  * <ul>
59  * <li>(in) widget the <code>Browser</code> whose current URL has been loaded
60  * </ul>
61  * 
62  * @param event the <code>ProgressEvent</code> related to the <code>Browser</code>
63  * that has loaded its current URL.
64  * 
65  * @since 3.0
66  */
67 public void completed(ProgressEvent event);
68 }