annotate org/eclipse/swt/graphics/LineAttributes.d @ 5:de77855733ca

more ...
author Frank Benoit <benoit@tionex.de>
date Sat, 05 Jan 2008 05:40:52 +0100
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
1 /*******************************************************************************
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
2 * Copyright (c) 2000, 2007 IBM Corporation and others.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
3 * All rights reserved. This program and the accompanying materials
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
4 * are made available under the terms of the Eclipse Public License v1.0
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
5 * which accompanies this distribution, and is available at
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
6 * http://www.eclipse.org/legal/epl-v10.html
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
7 *
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
8 * Contributors:
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
9 * IBM Corporation - initial API and implementation
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
10 *******************************************************************************/
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
11 module org.eclipse.swt.graphics.LineAttributes;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
12
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
13 import org.eclipse.swt.SWT;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
14
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
15 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
16 * <code>LineAttributes</code> defines a set of line attributes that
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
17 * can be modified in a GC.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
18 * <p>
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
19 * Application code does <em>not</em> need to explicitly release the
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
20 * resources managed by each instance when those instances are no longer
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
21 * required, and thus no <code>dispose()</code> method is provided.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
22 * </p>
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
23 *
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
24 * @see GC#getLineAttributes()
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
25 * @see GC#setLineAttributes(LineAttributes)
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
26 *
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
27 * @since 3.3
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
28 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
29 public class LineAttributes {
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
30
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
31 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
32 * The line width.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
33 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
34 public float width;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
35
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
36 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
37 * The line style.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
38 *
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
39 * @see org.eclipse.swt.SWT#LINE_CUSTOM
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
40 * @see org.eclipse.swt.SWT#LINE_DASH
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
41 * @see org.eclipse.swt.SWT#LINE_DASHDOT
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
42 * @see org.eclipse.swt.SWT#LINE_DASHDOTDOT
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
43 * @see org.eclipse.swt.SWT#LINE_DOT
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
44 * @see org.eclipse.swt.SWT#LINE_SOLID
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
45 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
46 public int style;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
47
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
48 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
49 * The line cap style.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
50 *
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
51 * @see org.eclipse.swt.SWT#CAP_FLAT
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
52 * @see org.eclipse.swt.SWT#CAP_ROUND
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
53 * @see org.eclipse.swt.SWT#CAP_SQUARE
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
54 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
55 public int cap;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
56
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
57 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
58 * The line join style.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
59 *
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
60 * @see org.eclipse.swt.SWT#JOIN_BEVEL
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
61 * @see org.eclipse.swt.SWT#JOIN_MITER
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
62 * @see org.eclipse.swt.SWT#JOIN_ROUND
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
63 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
64 public int join;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
65
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
66 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
67 * The line dash style for SWT.LINE_CUSTOM.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
68 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
69 public float[] dash;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
70
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
71 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
72 * The line dash style offset for SWT.LINE_CUSTOM.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
73 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
74 public float dashOffset;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
75
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
76 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
77 * The line miter limit.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
78 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
79 public float miterLimit;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
80
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
81 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
82 * Create a new line attributes with the specified line width.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
83 *
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
84 * @param width the line width
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
85 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
86 public this(float width) {
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
87 this(width, SWT.CAP_FLAT, SWT.JOIN_MITER, SWT.LINE_SOLID, null, 0, 10);
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
88 }
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
89
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
90 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
91 * Create a new line attributes with the specified line cap, join and width.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
92 *
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
93 * @param width the line width
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
94 * @param cap the line cap style
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
95 * @param join the line join style
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
96 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
97 public this(float width, int cap, int join) {
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
98 this(width, cap, join, SWT.LINE_SOLID, null, 0, 10);
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
99 }
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
100
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
101 /**
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
102 * Create a new line attributes with the specified arguments.
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
103 *
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
104 * @param width the line width
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
105 * @param cap the line cap style
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
106 * @param join the line join style
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
107 * @param style the line style
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
108 * @param dash the line dash style
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
109 * @param dashOffset the line dash style offset
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
110 * @param miterLimit the line miter limit
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
111 */
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
112 public this(float width, int cap, int join, int style, float[] dash, float dashOffset, float miterLimit) {
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
113 this.width = width;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
114 this.cap = cap;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
115 this.join = join;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
116 this.style = style;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
117 this.dash = dash;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
118 this.dashOffset = dashOffset;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
119 this.miterLimit = miterLimit;
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
120 }
de77855733ca more ...
Frank Benoit <benoit@tionex.de>
parents:
diff changeset
121 }