annotate dwt/graphics/FontMetrics.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 b6bee07cfc0b
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: 194
diff changeset
2 * Copyright (c) 2000, 2008 IBM Corporation and others.
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
94c5d794407f more simple classes
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>
4
94c5d794407f more simple classes
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.graphics.FontMetrics;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 * Instances of this class provide measurement information
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 * about fonts including ascent, descent, height, leading
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * space between rows, and average character width.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * <code>FontMetrics</code> are obtained from <code>GC</code>s
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * using the <code>getFontMetrics()</code> method.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * @see GC#getFontMetrics
259
c0d810de7093 Update SWT 3.4M7 to 3.4
Frank Benoit <benoit@tionex.de>
parents: 194
diff changeset
24 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 public final class FontMetrics {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
27 int ascent, descent, averageCharWidth, leading, height;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 package this() {
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * Compares the argument to the receiver, and returns true
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * if they represent the <em>same</em> object using a class
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 * specific comparison.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * @param object the object to compare with this object
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 * @return <code>true</code> if the object is the same as this object and <code>false</code> otherwise
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * @see #hashCode
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 */
150
f2e04420fd6c reworked overrides and superclass aliases
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
42 public override int opEquals (Object object) {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
43 if (object is this) return true;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 if( auto metrics = cast(FontMetrics)object ){
194
b6bee07cfc0b Fix ==/!= to is/!is
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
45 return ascent is metrics.ascent && descent is metrics.descent &&
b6bee07cfc0b Fix ==/!= to is/!is
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
46 averageCharWidth is metrics.averageCharWidth && leading is metrics.leading &&
b6bee07cfc0b Fix ==/!= to is/!is
Frank Benoit <benoit@tionex.de>
parents: 150
diff changeset
47 height is metrics.height;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 }
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
49 return false;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * Returns the ascent of the font described by the receiver. A
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 * font's <em>ascent</em> is the distance from the baseline to the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 * top of actual characters, not including any of the leading area,
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * measured in pixels.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * @return the ascent of the font
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 public int getAscent() {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
61 return ascent;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 * Returns the average character width, measured in pixels,
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 * of the font described by the receiver.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 * @return the average character width of the font
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 public int getAverageCharWidth() {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
71 return averageCharWidth;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 * Returns the descent of the font described by the receiver. A
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 * font's <em>descent</em> is the distance from the baseline to the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * bottom of actual characters, not including any of the leading area,
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * measured in pixels.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * @return the descent of the font
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 public int getDescent() {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
83 return descent;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 * Returns the height of the font described by the receiver,
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 * measured in pixels. A font's <em>height</em> is the sum of
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89 * its ascent, descent and leading area.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 * @return the height of the font
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * @see #getAscent
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 * @see #getDescent
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 * @see #getLeading
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 public int getHeight() {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
98 return height;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 * Returns the leading area of the font described by the
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 * receiver. A font's <em>leading area</em> is the space
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 * above its ascent which may include accents or other marks.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 * @return the leading space of the font
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 */
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 public int getLeading() {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
109 return leading;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 public static FontMetrics gtk_new(int ascent, int descent, int averageCharWidth, int leading, int height) {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
113 FontMetrics fontMetrics = new FontMetrics();
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
114 fontMetrics.ascent = ascent;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
115 fontMetrics.descent = descent;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
116 fontMetrics.averageCharWidth = averageCharWidth;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
117 fontMetrics.leading = leading;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
118 fontMetrics.height = height;
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
119 return fontMetrics;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
122 /**
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
123 * Returns an integer hash code for the receiver. Any two
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
124 * objects that return <code>true</code> when passed to
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
125 * <code>equals</code> must return the same value for this
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
126 * method.
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
127 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
128 * @return the receiver's hash
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
129 *
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
130 * @see #equals
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
131 */
150
f2e04420fd6c reworked overrides and superclass aliases
Frank Benoit <benoit@tionex.de>
parents: 72
diff changeset
132 public override hash_t toHash() {
59
8cec8f536af3 All D sources complete gvim retab (4 spaces), bug with Composite moveAbove/moveBelow fixed.
Frank Benoit <benoit@tionex.de>
parents: 10
diff changeset
133 return ascent ^ descent ^ averageCharWidth ^ leading ^ height;
4
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
134 }
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
135
94c5d794407f more simple classes
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
136 }