xref: /aoo41x/main/offapi/com/sun/star/chart2/Symbol.idl (revision d1766043)
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_chart2_Symbol_idl
24#define com_sun_star_chart2_Symbol_idl
25
26#ifndef __com_sun_star_drawing_PolyPolygonBezierCoords_idl__
27#include <com/sun/star/drawing/PolyPolygonBezierCoords.idl>
28#endif
29
30#include <com/sun/star/awt/Size.idl>
31#include <com/sun/star/graphic/XGraphic.idl>
32
33#include <com/sun/star/chart2/SymbolStyle.idl>
34
35//=============================================================================
36
37module com {  module sun {  module star {  module chart2 {
38
39//=============================================================================
40
41/** properties that are used for DataSeries that display symbols.
42 */
43struct Symbol
44{
45    /** determines which of the following members determines the
46        appearance of the symbol.
47     */
48    SymbolStyle                                 		Style;
49
50    /** The given polygon is used as symbol.
51     */
52    com::sun::star::drawing::PolyPolygonBezierCoords	PolygonCoords;
53
54    /** Use the nth standard symbol, if <member>Style</member> is set
55        to <member>SymbolStlye::STANDARD</member>.
56
57        <p>If n is the number of standard symbols available in an
58        implementation, the symbol number is
59        <member>StandardSymbol</member> modulo n.</p>
60
61        <p>The default implementation for example currently uses 8 different
62        standard symbols that are matched to the numbers 0 to 7.
63
64        <table border=1 rules="groups">
65        <thead>
66        <tr><th>&nbsp;value StandardSymbol&nbsp;</th><th>&nbsp;visible Symbol&nbsp;</th></tr>
67        </thead>
68        <tbody>
69        <tr><td><code>0</code></td><td>square</td></tr>
70        <tr><td><code>1</code></td><td>diamond</td></tr>
71        <tr><td><code>2</code></td><td>down arrow</td></tr>
72        <tr><td><code>3</code></td><td>up arrow</td></tr>
73        <tr><td><code>4</code></td><td>right arrow</td></tr>
74        <tr><td><code>5</code></td><td>left arrow</td></tr>
75        <tr><td><code>6</code></td><td>bowtie</td></tr>
76        <tr><td><code>7</code></td><td>sandglass</td></tr>
77        </tbody>
78        </table>
79
80        </p>
81     */
82    long 												StandardSymbol;
83
84    /** use this graphic as symbol
85     */
86    com::sun::star::graphic::XGraphic 					Graphic;
87
88    /** The size of the symbol in 100th of a mm.
89
90        @todo use a structure using doubles insted of longs
91     */
92    com::sun::star::awt::Size 							Size;
93
94    /** The color used for drawing the border of symbols.
95
96        <p>Only effective if <member>Style</member> is
97        <member>SymbolStyle::AUTO</member>,
98        <member>SymbolStyle::STANDARD</member> or
99        <member>SymbolStyle::POLYGON</member>.</p>
100     */
101    long 												BorderColor;
102
103    /** The color used for filling symbols that contain closed polygons.
104
105        <p>Only effective if <member>Style</member> is
106        <member>SymbolStyle::AUTO</member>,
107        <member>SymbolStyle::STANDARD</member> or
108        <member>SymbolStyle::POLYGON</member>.</p>
109     */
110    long 												FillColor;
111};
112
113//=============================================================================
114
115}; }; }; };
116
117#endif
118
119