xref: /aoo42x/main/offapi/com/sun/star/drawing/LineProperties.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_drawing_LineProperties_idl__
#define __com_sun_star_drawing_LineProperties_idl__

#ifndef __com_sun_star_drawing_LineStyle_idl__
#include <com/sun/star/drawing/LineStyle.idl>
#endif

#ifndef __com_sun_star_util_Color_idl__
#include <com/sun/star/util/Color.idl>
#endif

#ifndef __com_sun_star_drawing_LineDash_idl__
#include <com/sun/star/drawing/LineDash.idl>
#endif

#ifndef __com_sun_star_drawing_PolyPolygonBezierCoords_idl__
#include <com/sun/star/drawing/PolyPolygonBezierCoords.idl>
#endif

#ifndef __com_sun_star_drawing_LineJoint_idl__
#include <com/sun/star/drawing/LineJoint.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module drawing {

//=============================================================================

/** This is a set of properties to describe the style for rendering a Line.
	<p>The properties for line ends and line starts are only supported by
	shapes with open line ends.
 */
published service LineProperties
{
	/** This property contains the type of the line.
	 */
	[property] com::sun::star::drawing::LineStyle LineStyle;

	//-------------------------------------------------------------------------

	/** This property contains the dash of the line.
	 */
	[property] com::sun::star::drawing::LineDash LineDash;

	//-------------------------------------------------------------------------

	/** This property contains the name of the dash of the line.
	 */
	[optional, property] string LineDashName;

	//-------------------------------------------------------------------------

	/** This property contains the line color.
	 */
	[property] com::sun::star::util::Color LineColor;

	//-------------------------------------------------------------------------

	/** This property contains the extent of transparency.
	 */
	[property] short LineTransparence;

	//-------------------------------------------------------------------------

	/** This property contains the width of the line in 1/100th mm.
	 */
	[property] long LineWidth;

	//-------------------------------------------------------------------------

	/** This property defines the rendering of joints between thick lines
	 */
	[property] com::sun::star::drawing::LineJoint LineJoint;

	//-------------------------------------------------------------------------

	/** This property contains the name of the line start poly polygon bezier.
		<p>If this string is empty, no line start polygon is rendered.
	 */
	[optional, property] string LineStartName;

	//-------------------------------------------------------------------------

	/** This property contains the name of the line end poly polygon bezier.
		<p>If this string is empty, no line end polygon is rendered.
	 */
	[optional, property] string LineEndName;

	//-------------------------------------------------------------------------

	/** This property contains the line start in the form of a poly polygon bezier.
	 */
	[optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineStart;

	//-------------------------------------------------------------------------

	/** This property contains the line end in the form of a poly polygon bezier.
	 */
	[optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineEnd;

	//-------------------------------------------------------------------------

	/** If this property is <TRUE/>, the line will
		start from the center of the polygon.
	 */
	[optional, property] boolean LineStartCenter;

	//-------------------------------------------------------------------------

	/** This property contains the width of the line start polygon.
	 */
	[optional, property] long LineStartWidth;

	//-------------------------------------------------------------------------

	/** If this property is <TRUE/>, the line will end
		in the center of the polygon.
	 */
	[optional, property] boolean LineEndCenter;

	//-------------------------------------------------------------------------

	/** This property contains the width of the line end polygon.
	 */
	[optional, property] long LineEndWidth;
};

//=============================================================================

}; }; }; };

#endif