xref: /core/offapi/com/sun/star/drawing/LineProperties.idl (revision 5687eba49fa06202bd190c87ad8e7af634354799)
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 *   Licensed to the Apache Software Foundation (ASF) under one or more
12 *   contributor license agreements. See the NOTICE file distributed
13 *   with this work for additional information regarding copyright
14 *   ownership. The ASF licenses this file to you under the Apache
15 *   License, Version 2.0 (the "License"); you may not use this file
16 *   except in compliance with the License. You may obtain a copy of
17 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21module com {  module sun {  module star {  module drawing {
22
23
24/** This is a set of properties to describe the style for rendering a Line.
25    <p>The properties for line ends and line starts are only supported by
26    shapes with open line ends.
27 */
28published service LineProperties
29{
30    /** This property contains the type of the line.
31     */
32    [property] com::sun::star::drawing::LineStyle LineStyle;
33
34
35    /** This property contains the dash of the line.
36     */
37    [property] com::sun::star::drawing::LineDash LineDash;
38
39
40    /** This property contains the name of the dash of the line.
41     */
42    [optional, property] string LineDashName;
43
44
45    /** This property contains the line color.
46     */
47    [property] com::sun::star::util::Color LineColor;
48
49
50    /** This property contains the extent of transparency.
51     */
52    [property] short LineTransparence;
53
54
55    /** This property contains the width of the line in 1/100th mm.
56     */
57    [property] long LineWidth;
58
59
60    /** This property defines the rendering of joints between thick lines
61     */
62    [property] com::sun::star::drawing::LineJoint LineJoint;
63
64
65    /** This property defines the rendering of ends of thick lines
66     */
67    [optional, property] com::sun::star::drawing::LineCap LineCap;
68
69
70    /** This property contains the name of the line start poly polygon Bezier.
71        <p>If this string is empty, no line start polygon is rendered.
72     */
73    [optional, property] string LineStartName;
74
75
76    /** This property contains the name of the line end poly polygon Bezier.
77        <p>If this string is empty, no line end polygon is rendered.
78     */
79    [optional, property] string LineEndName;
80
81
82    /** This property contains the line start in the form of a poly polygon Bezier.
83     */
84    [optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineStart;
85
86
87    /** This property contains the line end in the form of a poly polygon Bezier.
88     */
89    [optional, property] com::sun::star::drawing::PolyPolygonBezierCoords LineEnd;
90
91
92    /** If this property is `TRUE`, the line will
93        start from the center of the polygon.
94     */
95    [optional, property] boolean LineStartCenter;
96
97
98    /** This property contains the width of the line start polygon.
99     */
100    [optional, property] long LineStartWidth;
101
102
103    /** If this property is `TRUE`, the line will end
104        in the center of the polygon.
105     */
106    [optional, property] boolean LineEndCenter;
107
108
109    /** This property contains the width of the line end polygon.
110     */
111    [optional, property] long LineEndWidth;
112};
113
114
115}; }; }; };
116
117/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
118