/*******************************************************************************
 * Copyright (c) 2000, 2008 IBM Corporation and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     IBM Corporation - initial API and implementation
 *     
 * Port to the D programming language:
 *     Jacob Carlborg <doob@me.com>
 *******************************************************************************/
module dwt.graphics.LineAttributes;

import dwt.DWT;

import dwt.dwthelper.utils;
import dwt.internal.c.Carbon;

/**
 * <code>LineAttributes</code> defines a set of line attributes that
 * can be modified in a GC.
 * <p>
 * Application code does <em>not</em> need to explicitly release the
 * resources managed by each instance when those instances are no longer
 * required, and thus no <code>dispose()</code> method is provided.
 * </p>
 * 
 * @see GC#getLineAttributes()
 * @see GC#setLineAttributes(LineAttributes)
 * @see <a href="http://www.eclipse.org/swt/">Sample code and further information</a>
 *  
 * @since 3.3
 */
public class LineAttributes {

    /**
     * The line width.
     */
    public CGFloat width;

    /**
     * The line style.
     * 
     * @see dwt.DWT#LINE_CUSTOM
     * @see dwt.DWT#LINE_DASH
     * @see dwt.DWT#LINE_DASHDOT
     * @see dwt.DWT#LINE_DASHDOTDOT
     * @see dwt.DWT#LINE_DOT
     * @see dwt.DWT#LINE_SOLID
     */
    public int style;

    /**
     * The line cap style.
     * 
     * @see dwt.DWT#CAP_FLAT
     * @see dwt.DWT#CAP_ROUND
     * @see dwt.DWT#CAP_SQUARE
     */
    public int cap;

    /**
     * The line join style.
     * 
     * @see dwt.DWT#JOIN_BEVEL
     * @see dwt.DWT#JOIN_MITER
     * @see dwt.DWT#JOIN_ROUND
     */
    public int join;

    /**
     * The line dash style for DWT.LINE_CUSTOM.
     */
    public CGFloat[] dash;

    /**
     * The line dash style offset for DWT.LINE_CUSTOM.
     */
    public CGFloat dashOffset;

    /**
     * The line miter limit.
     */
    public CGFloat miterLimit;

/** 
 * Create a new line attributes with the specified line width.
 *
 * @param width the line width
 */
public this(CGFloat width) {
    this(width, DWT.CAP_FLAT, DWT.JOIN_MITER, DWT.LINE_SOLID, null, 0, 10);
}
    
/** 
 * Create a new line attributes with the specified line cap, join and width.
 *
 * @param width the line width
 * @param cap the line cap style
 * @param join the line join style
 */
public this(CGFloat width, int cap, int join) {
    this(width, cap, join, DWT.LINE_SOLID, null, 0, 10);
}

/** 
 * Create a new line attributes with the specified arguments.
 *
 * @param width the line width
 * @param cap the line cap style
 * @param join the line join style
 * @param style the line style
 * @param dash the line dash style
 * @param dashOffset the line dash style offset
 * @param miterLimit the line miter limit
 */
public this(CGFloat width, int cap, int join, int style, CGFloat[] dash, CGFloat dashOffset, CGFloat miterLimit) {
    this.width = width;
    this.cap = cap;
    this.join = join;
    this.style = style;
    this.dash = dash;
    this.dashOffset = dashOffset;
    this.miterLimit = miterLimit;
}
}