/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/



#ifndef _SVX_XDASH_HXX
#define _SVX_XDASH_HXX

//-------------
// class XDash
//-------------

#include <svx/xenum.hxx>
#include "svx/svxdllapi.h"

#include <vector>

class SVX_DLLPUBLIC XDash
{
protected:
	XDashStyle  eDash;
	sal_uInt16      nDots;
	sal_uIntPtr       nDotLen;
	sal_uInt16      nDashes;
	sal_uIntPtr       nDashLen;
	sal_uIntPtr       nDistance;

public:
		  XDash(XDashStyle eDash = XDASH_RECT,
				sal_uInt16 nDots = 1, sal_uIntPtr nDotLen = 20,
				sal_uInt16 nDashes = 1, sal_uIntPtr nDashLen = 20, sal_uIntPtr nDistance = 20);

	bool operator==(const XDash& rDash) const;

	void SetDashStyle(XDashStyle eNewStyle) { eDash = eNewStyle; }
	void SetDots(sal_uInt16 nNewDots)           { nDots = nNewDots; }
	void SetDotLen(sal_uIntPtr nNewDotLen)        { nDotLen = nNewDotLen; }
	void SetDashes(sal_uInt16 nNewDashes)       { nDashes = nNewDashes; }
	void SetDashLen(sal_uIntPtr nNewDashLen)      { nDashLen = nNewDashLen; }
	void SetDistance(sal_uIntPtr nNewDistance)    { nDistance = nNewDistance; }

	XDashStyle  GetDashStyle() const        { return eDash; }
	sal_uInt16      GetDots() const             { return nDots; }
	sal_uIntPtr       GetDotLen() const           { return nDotLen; }
	sal_uInt16      GetDashes() const           { return nDashes; }
	sal_uIntPtr       GetDashLen() const          { return nDashLen; }
	sal_uIntPtr       GetDistance() const         { return nDistance; }

	// XDash is translated into an array of doubles which describe the lengths of the 
	// dashes, dots and empty passages. It returns the complete length of the full DashDot 
	// sequence and fills the given vetor of doubles accordingly (also resizing, so deleting it).
	double CreateDotDashArray(::std::vector< double >& rDotDashArray, double fLineWidth) const;
};

#endif