Mercurial > projects > dwt-win

annotate dwt/custom/CTabFolderListener.d @ 311:02332a154347

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improved Listeners access functions.
author Frank Benoit <benoit@tionex.de>
date Tue, 16 Sep 2008 15:19:38 +0200
parents a5afe31f5cdd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
155
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2005 IBM Corporation and others.
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwt.custom.CTabFolderListener;
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwt.internal.DWTEventListener;
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import dwt.custom.CTabFolderEvent;
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17
311
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
18 import tango.core.Traits;
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
19 import tango.core.Tuple;
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
20
155
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 /**
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * Classes which implement this interface provide a method
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * that deals with events generated in the CTabFolder.
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * <p>
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * After creating an instance of a class that :
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * this interface it can be added to a CTabFolder using the
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * <code>addCTabFolderListener</code> method and removed using
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * the <code>removeCTabFolderListener</code> method. When a
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * tab item is closed, the itemClosed method will be invoked.
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * </p>
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 *
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * @see CTabFolderEvent
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 */
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 public interface CTabFolderListener : DWTEventListener {
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 /**
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * Sent when the user clicks on the close button of an item in the CTabFolder. The item being closed is specified
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * in the event.item field. Setting the event.doit field to false will stop the CTabItem from closing.
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * When the CTabItem is closed, it is disposed. The contents of the CTabItem (see CTabItem.setControl) will be
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * made not visible when the CTabItem is closed.
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 *
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * @param event an event indicating the item being closed
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 *
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * @see CTabItem#setControl
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 */
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 public void itemClosed(CTabFolderEvent event);
a5afe31f5cdd Added custom controls
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 }
311
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
48
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
49
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
50
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
51 /// Helper class for the dgListener template function
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
52 private class _DgCTabFolderListenerT(Dg,T...) : CTabFolderListener {
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
53
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
54 alias ParameterTupleOf!(Dg) DgArgs;
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
55 static assert( is(DgArgs == Tuple!(CTabFolderEvent,T)),
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
56 "Delegate args not correct" );
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
57
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
58 Dg dg;
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
59 T t;
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
60
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
61 private this( Dg dg, T t ){
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
62 this.dg = dg;
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
63 static if( T.length > 0 ){
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
64 this.t = t;
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
65 }
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
66 }
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
67
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
68 void itemClosed( CTabFolderEvent e ){
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
69 dg(e,t);
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
70 }
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
71 }
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
72
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
73 /++
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
74 + dgListener creates a class implementing the Listener interface and delegating the call to
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
75 + handleEvent to the users delegate. This template function will store also additional parameters.
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
76 +
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
77 + Examle of usage:
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
78 + ---
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
79 + void handleTextEvent (Event e, int inset ) {
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
80 + // ...
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
81 + }
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
82 + text.addListener (DWT.FocusOut, dgListener( &handleTextEvent, inset ));
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
83 + ---
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
84 +/
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
85 CTabFolderListener dgCTabFolderListener( Dg, T... )( Dg dg, T args ){
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
86 return new _DgCTabFolderListenerT!( Dg, T )( dg, args );
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
87 }
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
88
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
89
02332a154347 Improved Listeners access functions.
Frank Benoit <benoit@tionex.de>
parents: 155
diff changeset
90