xref: /AOO41X/main/offapi/com/sun/star/drawing/LineProperties.idl (revision 5aaf853b3ba91aa8a4f8154519fb0bf086e1a428)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_drawing_LineProperties_idl__
24#define __com_sun_star_drawing_LineProperties_idl__
25
26#include <com/sun/star/drawing/LineStyle.idl>
27#include <com/sun/star/util/Color.idl>
28#include <com/sun/star/drawing/LineDash.idl>
29#include <com/sun/star/drawing/PolyPolygonBezierCoords.idl>
30#include <com/sun/star/drawing/LineJoint.idl>
31#include <com/sun/star/drawing/LineCap.idl>
32
33//=============================================================================
34
35 module com {  module sun {  module star {  module drawing {
36
37//=============================================================================
38
39/** This is a set of properties to describe the style for rendering a Line.
40    <p>The properties for line ends and line starts are only supported by
41    shapes with open line ends.
42 */
43published service LineProperties
44{
45    /** This property contains the type of the line.
46     */
47    [property] com::sun::star::drawing::LineStyle LineStyle;
48
49    //-------------------------------------------------------------------------
50
51    /** This property contains the dash of the line.
52     */
53    [property] com::sun::star::drawing::LineDash LineDash;
54
55    //-------------------------------------------------------------------------
56
57    /** This property contains the name of the dash of the line.
58     */
59    [optional, property] string LineDashName;
60
61    //-------------------------------------------------------------------------
62
63    /** This property contains the line color.
64     */
65    [property] com::sun::star::util::Color LineColor;
66
67    //-------------------------------------------------------------------------
68
69    /** This property contains the extent of transparency.
70     */
71    [property] short LineTransparence;
72
73    //-------------------------------------------------------------------------
74
75    /** This property contains the width of the line in 1/100th mm.
76     */
77    [property] long LineWidth;
78
79    //-------------------------------------------------------------------------
80
81    /** This property defines the rendering of joints between thick lines
82     */
83    [property] com::sun::star::drawing::LineJoint LineJoint;
84
85    //-------------------------------------------------------------------------
86
87    /** This property defines the rendering of ends of thick lines
88     */
89    [optional, property] com::sun::star::drawing::LineCap LineCap;
90
91    //-------------------------------------------------------------------------
92
93    /** This property contains the name of the line start poly polygon bezier.
94        <p>If this string is empty, no line start polygon is rendered.
95     */
96    [optional, property] string LineStartName;
97
98    //-------------------------------------------------------------------------
99
100    /** This property contains the name of the line end poly polygon bezier.
101        <p>If this string is empty, no line end polygon is rendered.
102     */
103    [optional, property] string LineEndName;
104
105    //-------------------------------------------------------------------------
106
107    /** This property contains the line start in the form of a poly polygon bezier.
108     */
109    [optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineStart;
110
111    //-------------------------------------------------------------------------
112
113    /** This property contains the line end in the form of a poly polygon bezier.
114     */
115    [optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineEnd;
116
117    //-------------------------------------------------------------------------
118
119    /** If this property is <TRUE/>, the line will
120        start from the center of the polygon.
121     */
122    [optional, property] boolean LineStartCenter;
123
124    //-------------------------------------------------------------------------
125
126    /** This property contains the width of the line start polygon.
127     */
128    [optional, property] long LineStartWidth;
129
130    //-------------------------------------------------------------------------
131
132    /** If this property is <TRUE/>, the line will end
133        in the center of the polygon.
134     */
135    [optional, property] boolean LineEndCenter;
136
137    //-------------------------------------------------------------------------
138
139    /** This property contains the width of the line end polygon.
140     */
141    [optional, property] long LineEndWidth;
142};
143
144//=============================================================================
145
146}; }; }; };
147
148#endif
149
150