Mercurial > projects > dwt-mac
diff dwt/browser/VisibilityWindowListener.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/VisibilityWindowListener.d Sat Aug 09 17:00:02 2008 +0200 @@ -0,0 +1,96 @@ +/******************************************************************************* + * Copyright (c) 2003, 2007 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.VisibilityWindowListener; + +import dwt.browser.WindowEvent; +import dwt.dwthelper.utils; +import dwt.internal.DWTEventListener; + +/** + * This listener interface may be implemented in order to receive + * a {@link WindowEvent} notification when a window hosting a + * {@link Browser} needs to be displayed or hidden. + * + * @see Browser#addVisibilityWindowListener(VisibilityWindowListener) + * @see Browser#removeVisibilityWindowListener(VisibilityWindowListener) + * @see OpenWindowListener + * @see CloseWindowListener + * + * @since 3.0 + */ +public interface VisibilityWindowListener : DWTEventListener { + + /** + * This method is called when the window hosting a <code>Browser</code> + * is requested to be hidden. Application would typically hide the + * {@link dwt.widgets.Shell} that hosts the <code>Browser</code>. + * <p> + * + * <p>The following fields in the <code>WindowEvent</code> apply: + * <ul> + * <li>(in) widget the <code>Browser</code> that needs to be hidden + * </ul> + * + * @param event the <code>WindowEvent</code> that specifies the + * <code>Browser</code> that needs to be hidden + * + * @see dwt.widgets.Shell#setVisible(bool) + * + * @since 3.0 + */ + public void hide (WindowEvent event); + + /** + * This method is called when the window hosting a <code>Browser</code> + * is requested to be displayed. Application would typically set the + * location and the size of the {@link dwt.widgets.Shell} + * that hosts the <code>Browser</code>, if a particular location and size + * are specified. The application would then open that <code>Shell</code>. + * <p> + * + * <p>The following fields in the <code>WindowEvent</code> apply: + * <ul> + * <li>(in) widget the <code>Browser</code> to display + * <li>(in) location the requested location for the <code>Shell</code> + * hosting the browser. It is <code>null</code> if no location is set. + * <li>(in) size the requested size for the <code>Browser</code>. + * The client area of the <code>Shell</code> hosting the + * <code>Browser</code> should be large enough to accommodate that size. + * It is <code>null</code> if no size is set. + * <li>(in) addressBar <code>true</code> if the <code>Shell</code> + * hosting the <code>Browser</code> should display an address bar or + * <code>false</code> otherwise + * <li>(in) menuBar <code>true</code> if the <code>Shell</code> + * hosting the <code>Browser</code> should display a menu bar or + * <code>false</code> otherwise + * <li>(in) statusBar <code>true</code> if the <code>Shell</code> + * hosting the <code>Browser</code> should display a status bar or + * <code>false</code> otherwise + * <li>(in) toolBar <code>true</code> if the <code>Shell</code> + * hosting the <code>Browser</code> should display a tool bar or + * <code>false</code> otherwise + * </ul> + * + * @param event the <code>WindowEvent</code> that specifies the + * <code>Browser</code> that needs to be displayed + * + * @see dwt.widgets.Control#setLocation(dwt.graphics.Point) + * @see dwt.widgets.Control#setSize(dwt.graphics.Point) + * @see dwt.widgets.Shell#open() + * + * @since 3.0 + */ + public void show (WindowEvent event); + +}