Mercurial > projects > dwt-linux

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

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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, 2004 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.CTabFolder2Listener;
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 methods
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 * that deal with the events that are generated by the CTabFolder
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * control.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * <p>
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * After creating an instance of a class that :
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * 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
23 * <code>addCTabFolder2Listener</code> method and removed using
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * the <code>removeCTabFolder2Listener</code> method. When
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * events occurs in a CTabFolder the appropriate method
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * will be invoked.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * </p>
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 * @see CTabFolder2Adapter
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * @see CTabFolderEvent
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 * @since 3.0
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 */
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 public interface CTabFolder2Listener : DWTEventListener {
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35
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 * Sent when the user clicks on the close button of an item in the CTabFolder.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * The item being closed is specified in the event.item field.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * 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
40 * When the CTabItem is closed, it is disposed. The contents of the
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * CTabItem (see CTabItem.setControl) will be made not visible when
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * the CTabItem is closed.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * @param event an event indicating the item being closed
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 */
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 public void close(CTabFolderEvent event);
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 /**
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * Sent when the user clicks on the minimize button of a CTabFolder.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * The state of the CTabFolder does not change automatically - it
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * is up to the application to change the state of the CTabFolder
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * in response to this event using CTabFolder.setMinimized(true).
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * @param event an event containing information about the minimize
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * @see CTabFolder#getMinimized()
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * @see CTabFolder#setMinimized(bool)
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * @see CTabFolder#setMinimizeVisible(bool)
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 */
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 public void minimize(CTabFolderEvent event);
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 /**
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * Sent when the user clicks on the maximize button of a CTabFolder.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * The state of the CTabFolder does not change automatically - it
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * is up to the application to change the state of the CTabFolder
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * in response to this event using CTabFolder.setMaximized(true).
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * @param event an event containing information about the maximize
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * @see CTabFolder#getMaximized()
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 * @see CTabFolder#setMaximized(bool)
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 * @see CTabFolder#setMaximizeVisible(bool)
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 */
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 public void maximize(CTabFolderEvent event);
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 /**
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * Sent when the user clicks on the restore button of a CTabFolder.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * This event is sent either to restore the CTabFolder from the
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * minimized state or from the maximized state. To determine
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * which restore is requested, use CTabFolder.getMinimized() or
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 * CTabFolder.getMaximized() to determine the current state.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 * The state of the CTabFolder does not change automatically - it
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 * is up to the application to change the state of the CTabFolder
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 * in response to this event using CTabFolder.setMaximized(false)
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 * or CTabFolder.setMinimized(false).
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * @param event an event containing information about the restore
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * @see CTabFolder#getMinimized()
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 * @see CTabFolder#getMaximized()
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 * @see CTabFolder#setMinimized(bool)
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * @see CTabFolder#setMinimizeVisible(bool)
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * @see CTabFolder#setMaximized(bool)
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 * @see CTabFolder#setMaximizeVisible(bool)
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 */
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 public void restore(CTabFolderEvent event);
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 /**
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 * Sent when the user clicks on the chevron button of the CTabFolder.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 * A chevron appears in the CTabFolder when there are more tabs
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 * than can be displayed at the current widget size. To select a
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 * tab that is not currently visible, the user clicks on the
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 * chevron and selects a tab item from a list. By default, the
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 * CTabFolder provides a list of all the items that are not currently
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 * visible, however, the application can provide its own list by setting
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 * the event.doit field to <code>false</code> and displaying a selection list.
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 * @param event an event containing information about the show list
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 *
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 * @see CTabFolder#setSelection(CTabItem)
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 */
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 public void showList(CTabFolderEvent event);
12e3e0e477cd package custom, module and imports ok
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 }