Mercurial > projects > dwt-linux

comparison dwt/browser/VisibilityWindowListener.d @ 278:93409d9838c5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Commit more browser/xpcom updates, including still uncoverted source.
author John Reimer<terminal.node@gmail.com>
date Thu, 31 Jul 2008 19:17:51 -0700
parents
children bfe1c57259e3
comparison
equal deleted inserted replaced
277:687f261028b8 278:93409d9838c5
1 /*******************************************************************************
2 * Copyright (c) 2003, 2007 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 *******************************************************************************/
11 module dwt.browser.VisibilityWindowListener;
12
13 import dwt.dwthelper.utils;
14
15 import dwt.internal.DWTEventListener;
16
17 /**
18 * This listener interface may be implemented in order to receive
19 * a {@link WindowEvent} notification when a window hosting a
20 * {@link Browser} needs to be displayed or hidden.
21 *
22 * @see Browser#addVisibilityWindowListener(VisibilityWindowListener)
23 * @see Browser#removeVisibilityWindowListener(VisibilityWindowListener)
24 * @see OpenWindowListener
25 * @see CloseWindowListener
26 *
27 * @since 3.0
28 */
29 public interface VisibilityWindowListener extends DWTEventListener {
30
31 /**
32 * This method is called when the window hosting a <code>Browser</code>
33 * is requested to be hidden. Application would typically hide the
34 * {@link dwt.widgets.Shell} that hosts the <code>Browser</code>.
35 * <p>
36 *
37 * <p>The following fields in the <code>WindowEvent</code> apply:
38 * <ul>
39 * <li>(in) widget the <code>Browser</code> that needs to be hidden
40 * </ul>
41 *
42 * @param event the <code>WindowEvent</code> that specifies the
43 * <code>Browser</code> that needs to be hidden
44 *
45 * @see dwt.widgets.Shell#setVisible(bool)
46 *
47 * @since 3.0
48 */
49 public void hide(WindowEvent event);
50
51 /**
52 * This method is called when the window hosting a <code>Browser</code>
53 * is requested to be displayed. Application would typically set the
54 * location and the size of the {@link dwt.widgets.Shell}
55 * that hosts the <code>Browser</code>, if a particular location and size
56 * are specified. The application would then open that <code>Shell</code>.
57 * <p>
58 *
59 * <p>The following fields in the <code>WindowEvent</code> apply:
60 * <ul>
61 * <li>(in) widget the <code>Browser</code> to display
62 * <li>(in) location the requested location for the <code>Shell</code>
63 * hosting the browser. It is <code>null</code> if no location is set.
64 * <li>(in) size the requested size for the <code>Browser</code>.
65 * The client area of the <code>Shell</code> hosting the
66 * <code>Browser</code> should be large enough to accommodate that size.
67 * It is <code>null</code> if no size is set.
68 * <li>(in) addressBar <code>true</code> if the <code>Shell</code>
69 * hosting the <code>Browser</code> should display an address bar or
70 * <code>false</code> otherwise
71 * <li>(in) menuBar <code>true</code> if the <code>Shell</code>
72 * hosting the <code>Browser</code> should display a menu bar or
73 * <code>false</code> otherwise
74 * <li>(in) statusBar <code>true</code> if the <code>Shell</code>
75 * hosting the <code>Browser</code> should display a status bar or
76 * <code>false</code> otherwise
77 * <li>(in) toolBar <code>true</code> if the <code>Shell</code>
78 * hosting the <code>Browser</code> should display a tool bar or
79 * <code>false</code> otherwise
80 * </ul>
81 *
82 * @param event the <code>WindowEvent</code> that specifies the
83 * <code>Browser</code> that needs to be displayed
84 *
85 * @see dwt.widgets.Control#setLocation(dwt.graphics.Point)
86 * @see dwt.widgets.Control#setSize(dwt.graphics.Point)
87 * @see dwt.widgets.Shell#open()
88 *
89 * @since 3.0
90 */
91 public void show(WindowEvent event);
92
93 }