xref: /AOO41X/main/offapi/com/sun/star/drawing/LineProperties.idl (revision b2937f997bda0a05141a2d862a64f7be893955b7)
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#ifndef __com_sun_star_drawing_LineStyle_idl__
27#include <com/sun/star/drawing/LineStyle.idl>
28#endif
29
30#ifndef __com_sun_star_util_Color_idl__
31#include <com/sun/star/util/Color.idl>
32#endif
33
34#ifndef __com_sun_star_drawing_LineDash_idl__
35#include <com/sun/star/drawing/LineDash.idl>
36#endif
37
38#ifndef __com_sun_star_drawing_PolyPolygonBezierCoords_idl__
39#include <com/sun/star/drawing/PolyPolygonBezierCoords.idl>
40#endif
41
42#ifndef __com_sun_star_drawing_LineJoint_idl__
43#include <com/sun/star/drawing/LineJoint.idl>
44#endif
45
46
47//=============================================================================
48
49 module com {  module sun {  module star {  module drawing {
50
51//=============================================================================
52
53/** This is a set of properties to describe the style for rendering a Line.
54    <p>The properties for line ends and line starts are only supported by
55    shapes with open line ends.
56 */
57published service LineProperties
58{
59    /** This property contains the type of the line.
60     */
61    [property] com::sun::star::drawing::LineStyle LineStyle;
62
63    //-------------------------------------------------------------------------
64
65    /** This property contains the dash of the line.
66     */
67    [property] com::sun::star::drawing::LineDash LineDash;
68
69    //-------------------------------------------------------------------------
70
71    /** This property contains the name of the dash of the line.
72     */
73    [optional, property] string LineDashName;
74
75    //-------------------------------------------------------------------------
76
77    /** This property contains the line color.
78     */
79    [property] com::sun::star::util::Color LineColor;
80
81    //-------------------------------------------------------------------------
82
83    /** This property contains the extent of transparency.
84     */
85    [property] short LineTransparence;
86
87    //-------------------------------------------------------------------------
88
89    /** This property contains the width of the line in 1/100th mm.
90     */
91    [property] long LineWidth;
92
93    //-------------------------------------------------------------------------
94
95    /** This property defines the rendering of joints between thick lines
96     */
97    [property] com::sun::star::drawing::LineJoint LineJoint;
98
99    //-------------------------------------------------------------------------
100
101    /** This property contains the name of the line start poly polygon bezier.
102        <p>If this string is empty, no line start polygon is rendered.
103     */
104    [optional, property] string LineStartName;
105
106    //-------------------------------------------------------------------------
107
108    /** This property contains the name of the line end poly polygon bezier.
109        <p>If this string is empty, no line end polygon is rendered.
110     */
111    [optional, property] string LineEndName;
112
113    //-------------------------------------------------------------------------
114
115    /** This property contains the line start in the form of a poly polygon bezier.
116     */
117    [optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineStart;
118
119    //-------------------------------------------------------------------------
120
121    /** This property contains the line end in the form of a poly polygon bezier.
122     */
123    [optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineEnd;
124
125    //-------------------------------------------------------------------------
126
127    /** If this property is <TRUE/>, the line will
128        start from the center of the polygon.
129     */
130    [optional, property] boolean LineStartCenter;
131
132    //-------------------------------------------------------------------------
133
134    /** This property contains the width of the line start polygon.
135     */
136    [optional, property] long LineStartWidth;
137
138    //-------------------------------------------------------------------------
139
140    /** If this property is <TRUE/>, the line will end
141        in the center of the polygon.
142     */
143    [optional, property] boolean LineEndCenter;
144
145    //-------------------------------------------------------------------------
146
147    /** This property contains the width of the line end polygon.
148     */
149    [optional, property] long LineEndWidth;
150};
151
152//=============================================================================
153
154}; }; }; };
155
156#endif
157
158