annotate dwt/graphics/GlyphMetrics.d @ 212:ab60f3309436

reverted the char[] to String and use the an alias.
author Frank Benoit <benoit@tionex.de>
date Mon, 05 May 2008 00:12:38 +0200
parents 06825fa0ae76
children fd9c62a2998e
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2006 IBM Corporation and others.
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 * Port to the D programming language:
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 * Frank Benoit <benoit@tionex.de>
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12 *******************************************************************************/
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 module dwt.graphics.GlyphMetrics;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 import dwt.DWT;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 import tango.text.convert.Format;
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 12
diff changeset
17 import dwt.dwthelper.utils;
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 12
diff changeset
18
12
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 /**
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * Instances of this class represent glyph metrics.
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * <p>
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * The hashCode() method in this class uses the values of the public
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 * fields to compute the hash value. When storing instances of the
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * class in hashed collections, do not modify these fields after the
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * object has been inserted.
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 * </p>
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * <p>
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 * Application code does <em>not</em> need to explicitly release the
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 * resources managed by each instance when those instances are no longer
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30 * required, and thus no <code>dispose()</code> method is provided.
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 * </p>
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 *
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 * @see TextStyle
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 * @see TextLayout
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35 *
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 * @since 3.2
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 */
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 public final class GlyphMetrics {
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 /**
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * the ascent of the GlyphMetrics
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 */
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 public int ascent;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 /**
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 * the descent of the GlyphMetrics
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47 */
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 public int descent;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 /**
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * the width of the GlyphMetrics
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 */
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 public int width;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 /**
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56 * Constructs an instance of this class with the given
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 * ascent, descent and width values.
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 *
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 * @exception IllegalArgumentException <ul>
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * <li>ERROR_INVALID_ARGUMENT - if the ascent, descent or width argument is negative</li>
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * </ul>
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 */
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 public this(int ascent, int descent, int width) {
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 if (ascent < 0 || descent < 0 || width < 0) {
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65 DWT.error(DWT.ERROR_INVALID_ARGUMENT);
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 }
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 this.ascent = ascent;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 this.descent = descent;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 this.width = width;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70 }
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 /**
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 * Compares the argument to the receiver, and returns true
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 * if they represent the <em>same</em> object using a class
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75 * specific comparison.
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 *
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * @param object the object to compare with this object
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 * @return <code>true</code> if the object is the same as this object and <code>false</code> otherwise
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 *
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80 * @see #hashCode()
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 */
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 public override int opEquals (Object object) {
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 if (object is this) return true;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 if (auto metrics = cast(GlyphMetrics)object ){
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 return metrics.ascent == ascent && metrics.descent == descent && metrics.width == width;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 }
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 return false;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 }
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 /**
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 * Returns an integer hash code for the receiver. Any two
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * objects that return <code>true</code> when passed to
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 * <code>equals</code> must return the same value for this
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 * method.
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 *
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 * @return the receiver's hash
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 *
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 * @see #equals(Object)
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100 */
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 public override hash_t toHash () {
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 return ascent ^ descent ^ width;
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 }
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 /**
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 * Returns a string containing a concise, human-readable
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 * description of the receiver.
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 *
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 * @return a string representation of the <code>GlyphMetrics</code>
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 */
212
ab60f3309436 reverted the char[] to String and use the an alias.
Frank Benoit <benoit@tionex.de>
parents: 12
diff changeset
111 public override String toString () {
12
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 return Format( "GlyphMetrics {{{}, {}, {}}", ascent, descent, width ); //$NON-NLS-1$//$NON-NLS-2$ //$NON-NLS-3$ //$NON-NLS-4$
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 }
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114
06825fa0ae76 GlyphMetrics
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 }