Mercurial > projects > dwt-mac
comparison dwt/custom/CTabFolder2Listener.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 |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:380af2bdd8e5 |
---|---|
1 /******************************************************************************* | |
2 * Copyright (c) 2000, 2004 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 * Port to the D Programming language: | |
12 * Jacob Carlborg <jacob.carlborg@gmail.com> | |
13 *******************************************************************************/ | |
14 module dwt.custom.CTabFolder2Listener; | |
15 | |
16 import dwt.custom.CTabFolderEvent; | |
17 import dwt.internal.DWTEventListener; | |
18 | |
19 /** | |
20 * Classes which implement this interface provide methods | |
21 * that deal with the events that are generated by the CTabFolder | |
22 * control. | |
23 * <p> | |
24 * After creating an instance of a class that : | |
25 * this interface it can be added to a CTabFolder using the | |
26 * <code>addCTabFolder2Listener</code> method and removed using | |
27 * the <code>removeCTabFolder2Listener</code> method. When | |
28 * events occurs in a CTabFolder the appropriate method | |
29 * will be invoked. | |
30 * </p> | |
31 * | |
32 * @see CTabFolder2Adapter | |
33 * @see CTabFolderEvent | |
34 * | |
35 * @since 3.0 | |
36 */ | |
37 public interface CTabFolder2Listener : DWTEventListener { | |
38 | |
39 /** | |
40 * Sent when the user clicks on the close button of an item in the CTabFolder. | |
41 * The item being closed is specified in the event.item field. | |
42 * Setting the event.doit field to false will stop the CTabItem from closing. | |
43 * When the CTabItem is closed, it is disposed. The contents of the | |
44 * CTabItem (see CTabItem.setControl) will be made not visible when | |
45 * the CTabItem is closed. | |
46 * | |
47 * @param event an event indicating the item being closed | |
48 */ | |
49 public void close (CTabFolderEvent event); | |
50 | |
51 /** | |
52 * Sent when the user clicks on the minimize button of a CTabFolder. | |
53 * The state of the CTabFolder does not change automatically - it | |
54 * is up to the application to change the state of the CTabFolder | |
55 * in response to this event using CTabFolder.setMinimized(true). | |
56 * | |
57 * @param event an event containing information about the minimize | |
58 * | |
59 * @see CTabFolder#getMinimized() | |
60 * @see CTabFolder#setMinimized(bool) | |
61 * @see CTabFolder#setMinimizeVisible(bool) | |
62 */ | |
63 public void minimize (CTabFolderEvent event); | |
64 | |
65 /** | |
66 * Sent when the user clicks on the maximize button of a CTabFolder. | |
67 * The state of the CTabFolder does not change automatically - it | |
68 * is up to the application to change the state of the CTabFolder | |
69 * in response to this event using CTabFolder.setMaximized(true). | |
70 * | |
71 * @param event an event containing information about the maximize | |
72 * | |
73 * @see CTabFolder#getMaximized() | |
74 * @see CTabFolder#setMaximized(bool) | |
75 * @see CTabFolder#setMaximizeVisible(bool) | |
76 */ | |
77 public void maximize (CTabFolderEvent event); | |
78 | |
79 /** | |
80 * Sent when the user clicks on the restore button of a CTabFolder. | |
81 * This event is sent either to restore the CTabFolder from the | |
82 * minimized state or from the maximized state. To determine | |
83 * which restore is requested, use CTabFolder.getMinimized() or | |
84 * CTabFolder.getMaximized() to determine the current state. | |
85 * The state of the CTabFolder does not change automatically - it | |
86 * is up to the application to change the state of the CTabFolder | |
87 * in response to this event using CTabFolder.setMaximized(false) | |
88 * or CTabFolder.setMinimized(false). | |
89 * | |
90 * @param event an event containing information about the restore | |
91 * | |
92 * @see CTabFolder#getMinimized() | |
93 * @see CTabFolder#getMaximized() | |
94 * @see CTabFolder#setMinimized(bool) | |
95 * @see CTabFolder#setMinimizeVisible(bool) | |
96 * @see CTabFolder#setMaximized(bool) | |
97 * @see CTabFolder#setMaximizeVisible(bool) | |
98 */ | |
99 public void restore (CTabFolderEvent event); | |
100 | |
101 /** | |
102 * Sent when the user clicks on the chevron button of the CTabFolder. | |
103 * A chevron appears in the CTabFolder when there are more tabs | |
104 * than can be displayed at the current widget size. To select a | |
105 * tab that is not currently visible, the user clicks on the | |
106 * chevron and selects a tab item from a list. By default, the | |
107 * CTabFolder provides a list of all the items that are not currently | |
108 * visible, however, the application can provide its own list by setting | |
109 * the event.doit field to <code>false</code> and displaying a selection list. | |
110 * | |
111 * @param event an event containing information about the show list | |
112 * | |
113 * @see CTabFolder#setSelection(CTabItem) | |
114 */ | |
115 public void showList (CTabFolderEvent event); | |
116 } |