bundles/org.eclipse.swt.win32.win32.x86_64/src/org/eclipse/swt/browser/CloseWindowListener.java

   1 /*******************************************************************************
   2  * Copyright (c) 2003, 2016 IBM Corporation and others.
   3  *
   4  * This program and the accompanying materials
   5  * are made available under the terms of the Eclipse Public License 2.0
   6  * which accompanies this distribution, and is available at
   7  * https://www.eclipse.org/legal/epl-2.0/
   8  *
   9  * SPDX-License-Identifier: EPL-2.0
  10  *
  11  * Contributors:
  12  *     IBM Corporation - initial API and implementation
  13  *******************************************************************************/
  14 package org.eclipse.swt.browser;
  15
  16 import org.eclipse.swt.internal.*;
  17
  18 /**
  19  * This listener interface may be implemented in order to receive
  20  * a {@link WindowEvent} notification when a {@link Browser} is
  21  * about to be closed and when its host window should be closed
  22  * by the application.
  23  *
  24  * @see Browser#addCloseWindowListener(CloseWindowListener)
  25  * @see Browser#removeCloseWindowListener(CloseWindowListener)
  26  * @see OpenWindowListener
  27  * @see VisibilityWindowListener
  28  *
  29  * @since 3.0
  30  */
  31 @FunctionalInterface
  32 public interface CloseWindowListener extends SWTEventListener {
  33
  34 /**
  35  * This method is called when the window hosting a {@link Browser} should be closed.
  36  * Application would typically close the {@link org.eclipse.swt.widgets.Shell} that
  37  * hosts the <code>Browser</code>. The <code>Browser</code> is disposed after this
  38  * notification.
  39  *
  40  * <p>The following fields in the <code>WindowEvent</code> apply:</p>
  41  * <ul>
  42  * <li>(in) widget the <code>Browser</code> that is going to be disposed
  43  * </ul>
  44  *
  45  * @param event the <code>WindowEvent</code> that specifies the <code>Browser</code>
  46  * that is going to be disposed
  47  *
  48  * @see org.eclipse.swt.widgets.Shell#close()
  49  *
  50  * @since 3.0
  51  */
  52 public void close(WindowEvent event);
  53 }