annotate dwt/custom/CTabFolderListener.d @ 102:12e3e0e477cd

package custom, module and imports ok
author Frank Benoit <benoit@tionex.de>
date Fri, 18 Jan 2008 11:45:54 +0100
parents
children 0f12f6bb9739
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
102
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 module dwt.custom.CTabFolderListener;
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 import dwt.internal.DWTEventListener;
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14 import dwt.custom.CTabFolderEvent;
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 /**
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 * Classes which implement this interface provide a method
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 * that deals with events generated in the CTabFolder.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * <p>
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * After creating an instance of a class that :
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * this interface it can be added to a CTabFolder using the
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * <code>addCTabFolderListener</code> method and removed using
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * the <code>removeCTabFolderListener</code> method. When a
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * tab item is closed, the itemClosed method will be invoked.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * </p>
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * @see CTabFolderEvent
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 */
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 public interface CTabFolderListener : DWTEventListener {
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 /**
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * Sent when the user clicks on the close button of an item in the CTabFolder. The item being closed is specified
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * in the event.item field. Setting the event.doit field to false will stop the CTabItem from closing.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * When the CTabItem is closed, it is disposed. The contents of the CTabItem (see CTabItem.setControl) will be
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * made not visible when the CTabItem is closed.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * @param event an event indicating the item being closed
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * @see CTabItem#setControl
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 */
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 public void itemClosed(CTabFolderEvent event);
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 }