annotate dwt/events/MenuDetectEvent.d @ 10:63c023465156

moved from org.eclipse.swt to dwt
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Jan 2008 17:58:37 +0100
parents ad2b69216039
children 8cec8f536af3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2007 IBM Corporation and others.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
11 module dwt.events.MenuDetectEvent;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
14 import dwt.widgets.Event;
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
15 import dwt.events.TypedEvent;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 import tango.text.convert.Format;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * Instances of this class are sent whenever the platform-
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * specific trigger for showing a context menu is detected.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * @see MenuDetectListener
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * @since 3.3
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 public final class MenuDetectEvent : TypedEvent {
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * the display-relative x coordinate of the pointer
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * at the time the context menu trigger occurred
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 public int x;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * the display-relative y coordinate of the pointer
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * at the time the context menu trigger occurred
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 public int y;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * A flag indicating whether the operation should be allowed.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * Setting this field to <code>false</code> will cancel the operation.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 public bool doit;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 //private static final long serialVersionUID = -3061660596590828941L;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 * Constructs a new instance of this class based on the
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * information in the given untyped event.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * @param e the untyped event containing the information
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 public this(Event e) {
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 super(e);
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 this.x = e.x;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 this.y = e.y;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 this.doit = e.doit;
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 * Returns a string containing a concise, human-readable
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 * description of the receiver.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * @return a string representation of the event
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 public char[] toString() {
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 return Format( "{} x={} y={} doit={}}", super.toString[ 0 .. $-2 ], x, y, doit );
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 }