org.eclipse.swt.custom.CTabFolder2Adapter source code

1 /*******************************************************************************
2  * Copyright (c) 2000, 2008 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  *     Frank Benoit <benoit@tionex.de>
12  *******************************************************************************/
13 module org.eclipse.swt.custom.CTabFolder2Adapter;
14 import org.eclipse.swt.custom.CTabFolder2Listener;
15 import org.eclipse.swt.custom.CTabFolderEvent;
16 
17 /**
18  * This adapter class provides default implementations for the
19  * methods described by the <code>CTabFolder2Listener</code> interface.
20  * <p>
21  * Classes that wish to deal with <code>CTabFolderEvent</code>s can
22  * extend this class and override only the methods which they are
23  * interested in.
24  * </p>
25  *
26  * @see CTabFolder2Listener
27  * @see CTabFolderEvent
28  * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
29  *
30  * @since 3.0
31  */
32 public class CTabFolder2Adapter : CTabFolder2Listener {
33 
34 /**
35  * Sent when the user clicks on the close button of an item in the CTabFolder.  The item being closed is specified
36  * in the event.item field. Setting the event.doit field to false will stop  the CTabItem from closing.
37  * When the CTabItem is closed, it is disposed.  The contents of the CTabItem (see CTabItem#setControl) will be
38  * made not visible when the CTabItem is closed.
39  * <p>
40  * The default behaviour is to close the CTabItem.
41  * </p>
42  *
43  * @param event an event indicating the item being closed
44  */
45 public void close(CTabFolderEvent event){}
46 
47 /**
48  * Sent when the user clicks on the minimize button of a CTabFolder.
49  * <p>
50  * The default behaviour is to do nothing.
51  * </p>
52  *
53  * @param event an event containing information about the minimize
54  */
55 public void minimize(CTabFolderEvent event){}
56 
57 /**
58  * Sent when the user clicks on the maximize button of a CTabFolder.
59  * <p>
60  * The default behaviour is to do nothing.
61  * </p>
62  *
63  * @param event an event containing information about the maximize
64  */
65 public void maximize(CTabFolderEvent event){}
66 
67 /**
68  * Sent when the user clicks on the restore button of a CTabFolder.
69  * <p>
70  * The default behaviour is to do nothing.
71  * </p>
72  *
73  * @param event an event containing information about the restore
74  */
75 public void restore(CTabFolderEvent event){}
76 
77 /**
78  * Sent when the user clicks on the chevron button of a CTabFolder.
79  * <p>
80  * The default behaviour is to show a list of items that are not currently
81  * visible and to change the selection based on the item selected from the list.
82  * </p>
83  *
84  * @param event an event containing information about the show list
85  */
86 public void showList(CTabFolderEvent event){}
87 }