annotate dwt/events/PaintEvent.d @ 317:6f57d3b9947c

sync with dwt-win
author Frank Benoit <benoit@tionex.de>
date Tue, 16 Sep 2008 15:28:56 +0200
parents c0d810de7093
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
1 /*******************************************************************************
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 238
diff changeset
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
1
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
72
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
10 * Port to the D programming language:
5899e0b43e5d porting notice
Frank Benoit <benoit@tionex.de>
parents: 59
diff changeset
11 * Frank Benoit <benoit@tionex.de>
1
088b30eabff3 some events
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.PaintEvent;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
16 import dwt.widgets.Event;
24
bc06000c0816 TextLayout and GC, graphics complete
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
17 import dwt.graphics.GC;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18
10
63c023465156 moved from org.eclipse.swt to dwt
Frank Benoit <benoit@tionex.de>
parents: 9
diff changeset
19 import dwt.events.TypedEvent;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 import tango.text.convert.Format;
317
6f57d3b9947c sync with dwt-win
Frank Benoit <benoit@tionex.de>
parents: 259
diff changeset
22 import dwt.dwthelper.utils;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * Instances of this class are sent as a result of
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * visible areas of controls requiring re-painting.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * @see PaintListener
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 238
diff changeset
29 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 public final class PaintEvent : TypedEvent {
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
34 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
35 * the graphics context to use when painting
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
36 * that is configured to use the colors, font and
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
37 * damaged region of the control. It is valid
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
38 * only during the paint and must not be disposed
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
39 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
40 public GC gc;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
42 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
43 * the x offset of the bounding rectangle of the
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
44 * region that requires painting
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
45 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
46 public int x;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
48 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
49 * the y offset of the bounding rectangle of the
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
50 * region that requires painting
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
51 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
52 public int y;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
54 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
55 * the width of the bounding rectangle of the
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
56 * region that requires painting
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
57 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
58 public int width;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
60 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
61 * the height of the bounding rectangle of the
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
62 * region that requires painting
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
63 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
64 public int height;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
66 /**
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
67 * the number of following paint events which
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * are pending which may always be zero on
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
69 * some platforms
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
70 */
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
71 public int count;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
73 //static final long serialVersionUID = 3256446919205992497L;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 * Constructs a new instance of this class based on the
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * information in the given untyped event.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 * @param e the untyped event containing the information
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 */
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 public this(Event e) {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
82 super(e);
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
83 this.gc = e.gc;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
84 this.x = e.x;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
85 this.y = e.y;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
86 this.width = e.width;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
87 this.height = e.height;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 24
diff changeset
88 this.count = e.count;
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 /**
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * Returns a string containing a concise, human-readable
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * description of the receiver.
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 *
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 * @return a string representation of the event
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 */
238
380bad9f6852 reverted char[] to String
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
97 public override String toString() {
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 return Format( "{} gc={} x={} y={} width={} height={} count={}}",
143
6cd44e0b522d activating the listeners
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
99 super.toString[ 0 .. $-1 ],
6cd44e0b522d activating the listeners
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
100 gc is null ? "null" : gc.toString,
6cd44e0b522d activating the listeners
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
101 x,
6cd44e0b522d activating the listeners
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
102 y,
6cd44e0b522d activating the listeners
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
103 width,
6cd44e0b522d activating the listeners
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
104 height,
6cd44e0b522d activating the listeners
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
105 count );
1
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 }
088b30eabff3 some events
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108