annotate dwt/events/ShellAdapter.d @ 259:c0d810de7093

Update SWT 3.4M7 to 3.4
author Frank Benoit <benoit@tionex.de>
date Sun, 29 Jun 2008 14:33:38 +0200
parents c8f6e8dc0fcf
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 121
diff changeset
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
3
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
10 * Port to the D programming language:
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
11 * Frank Benoit <benoit@tionex.de>
3
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
13 module dwt.events.ShellAdapter;
3
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
15 import dwt.events.ShellListener;
3
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 /**
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 * This adapter class provides default implementations for the
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * methods described by the <code>ShellListener</code> interface.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * <p>
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * Classes that wish to deal with <code>ShellEvent</code>s can
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * extend this class and override only the methods which they are
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * interested in.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * </p>
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 *
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * @see ShellListener
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * @see ShellEvent
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 121
diff changeset
28 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
3
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 */
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 public abstract class ShellAdapter : ShellListener {
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 /**
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * Sent when a shell becomes the active window.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * The default behavior is to do nothing.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 *
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * @param e an event containing information about the activation
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 */
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 public void shellActivated(ShellEvent e) {
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 }
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 /**
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * Sent when a shell is closed.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * The default behavior is to do nothing.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 *
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 * @param e an event containing information about the close
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 */
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 public void shellClosed(ShellEvent e) {
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 }
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 /**
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * Sent when a shell stops being the active window.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * The default behavior is to do nothing.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 *
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * @param e an event containing information about the deactivation
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 */
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 public void shellDeactivated(ShellEvent e) {
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 }
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 /**
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * Sent when a shell is un-minimized.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * The default behavior is to do nothing.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 *
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * @param e an event containing information about the un-minimization
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 */
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 public void shellDeiconified(ShellEvent e) {
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 }
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 /**
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 * Sent when a shell is minimized.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 * The default behavior is to do nothing.
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 *
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 * @param e an event containing information about the minimization
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 */
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 public void shellIconified(ShellEvent e) {
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 }
5dfd6e42e2ef some adapters
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 }
121
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
77
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
78 class ShellDelegator : ShellAdapter {
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
79 alias void delegate(ShellEvent) DFunc;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
80 DFunc delShellActivated;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
81 DFunc delShellClosed;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
82 DFunc delShellDeactivated;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
83 DFunc delShellDeiconified;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
84 DFunc delShellIconified;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
85
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
86 private this(
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
87 DFunc delShellActivated,
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
88 DFunc delShellClosed,
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
89 DFunc delShellDeactivated,
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
90 DFunc delShellDeiconified,
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
91 DFunc delShellIconified )
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
92 {
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
93 this.delShellActivated = delShellActivated;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
94 this.delShellClosed = delShellClosed;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
95 this.delShellDeactivated = delShellDeactivated;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
96 this.delShellDeiconified = delShellDeiconified;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
97 this.delShellIconified = delShellIconified;
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
98 }
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
99
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
100 static ShellDelegator createShellActivated( DFunc del ){
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
101 return new ShellDelegator( del, null, null, null, null );
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
102 }
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
103 static ShellDelegator createShellClosed( DFunc del ){
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
104 return new ShellDelegator( null, del, null, null, null );
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
105 }
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
106
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
107 public void shellActivated(ShellEvent e) {
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
108 if( delShellActivated !is null ) delShellActivated(e);
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
109 }
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
110 public void shellClosed(ShellEvent e) {
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
111 if( delShellClosed !is null ) delShellClosed(e);
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
112 }
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
113 public void shellDeactivated(ShellEvent e) {
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
114 if( delShellDeactivated !is null ) delShellDeactivated(e);
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
115 }
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
116 public void shellDeiconified(ShellEvent e) {
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
117 if( delShellDeiconified !is null ) delShellDeiconified(e);
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
118 }
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
119 public void shellIconified(ShellEvent e) {
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
120 if( delShellIconified !is null ) delShellIconified(e);
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
121 }
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
122 }
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
123
c8f6e8dc0fcf Possibly way for delegate integration
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
124