xref: /aoo42x/main/offapi/com/sun/star/chart2/Symbol.idl (revision c34b68ab)
1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir#ifndef com_sun_star_chart2_Symbol_idl
24cdf0e10cSrcweir#define com_sun_star_chart2_Symbol_idl
25cdf0e10cSrcweir
26cdf0e10cSrcweir#ifndef __com_sun_star_drawing_PolyPolygonBezierCoords_idl__
27cdf0e10cSrcweir#include <com/sun/star/drawing/PolyPolygonBezierCoords.idl>
28cdf0e10cSrcweir#endif
29cdf0e10cSrcweir
30cdf0e10cSrcweir#include <com/sun/star/awt/Size.idl>
31cdf0e10cSrcweir#include <com/sun/star/graphic/XGraphic.idl>
32cdf0e10cSrcweir
33cdf0e10cSrcweir#include <com/sun/star/chart2/SymbolStyle.idl>
34cdf0e10cSrcweir
35cdf0e10cSrcweir//=============================================================================
36cdf0e10cSrcweir
37cdf0e10cSrcweirmodule com {  module sun {  module star {  module chart2 {
38cdf0e10cSrcweir
39cdf0e10cSrcweir//=============================================================================
40cdf0e10cSrcweir
41cdf0e10cSrcweir/** properties that are used for DataSeries that display symbols.
42cdf0e10cSrcweir */
43cdf0e10cSrcweirstruct Symbol
44cdf0e10cSrcweir{
45cdf0e10cSrcweir    /** determines which of the following members determines the
46cdf0e10cSrcweir        appearance of the symbol.
47cdf0e10cSrcweir     */
48cdf0e10cSrcweir    SymbolStyle                                 		Style;
49cdf0e10cSrcweir
50cdf0e10cSrcweir    /** The given polygon is used as symbol.
51cdf0e10cSrcweir     */
52cdf0e10cSrcweir    com::sun::star::drawing::PolyPolygonBezierCoords	PolygonCoords;
53cdf0e10cSrcweir
54cdf0e10cSrcweir    /** Use the nth standard symbol, if <member>Style</member> is set
55cdf0e10cSrcweir        to <member>SymbolStlye::STANDARD</member>.
56cdf0e10cSrcweir
57cdf0e10cSrcweir        <p>If n is the number of standard symbols available in an
58cdf0e10cSrcweir        implementation, the symbol number is
59cdf0e10cSrcweir        <member>StandardSymbol</member> modulo n.</p>
60cdf0e10cSrcweir
61cdf0e10cSrcweir        <p>The default implementation for example currently uses 8 different
62cdf0e10cSrcweir        standard symbols that are matched to the numbers 0 to 7.
63cdf0e10cSrcweir
64cdf0e10cSrcweir        <table border=1 rules="groups">
65cdf0e10cSrcweir        <thead>
66cdf0e10cSrcweir        <tr><th>&nbsp;value StandardSymbol&nbsp;</th><th>&nbsp;visible Symbol&nbsp;</th></tr>
67cdf0e10cSrcweir        </thead>
68cdf0e10cSrcweir        <tbody>
69cdf0e10cSrcweir        <tr><td><code>0</code></td><td>square</td></tr>
70cdf0e10cSrcweir        <tr><td><code>1</code></td><td>diamond</td></tr>
71cdf0e10cSrcweir        <tr><td><code>2</code></td><td>down arrow</td></tr>
72cdf0e10cSrcweir        <tr><td><code>3</code></td><td>up arrow</td></tr>
73cdf0e10cSrcweir        <tr><td><code>4</code></td><td>right arrow</td></tr>
74cdf0e10cSrcweir        <tr><td><code>5</code></td><td>left arrow</td></tr>
75cdf0e10cSrcweir        <tr><td><code>6</code></td><td>bowtie</td></tr>
76cdf0e10cSrcweir        <tr><td><code>7</code></td><td>sandglass</td></tr>
77cdf0e10cSrcweir        </tbody>
78cdf0e10cSrcweir        </table>
79cdf0e10cSrcweir
80cdf0e10cSrcweir        </p>
81cdf0e10cSrcweir     */
82cdf0e10cSrcweir    long 												StandardSymbol;
83cdf0e10cSrcweir
84cdf0e10cSrcweir    /** use this graphic as symbol
85cdf0e10cSrcweir     */
86cdf0e10cSrcweir    com::sun::star::graphic::XGraphic 					Graphic;
87cdf0e10cSrcweir
88cdf0e10cSrcweir    /** The size of the symbol in 100th of a mm.
89cdf0e10cSrcweir
90*c34b68abSJohn Bampton        @todo use a structure using doubles instead of longs
91cdf0e10cSrcweir     */
92cdf0e10cSrcweir    com::sun::star::awt::Size 							Size;
93cdf0e10cSrcweir
94cdf0e10cSrcweir    /** The color used for drawing the border of symbols.
95cdf0e10cSrcweir
96cdf0e10cSrcweir        <p>Only effective if <member>Style</member> is
97cdf0e10cSrcweir        <member>SymbolStyle::AUTO</member>,
98cdf0e10cSrcweir        <member>SymbolStyle::STANDARD</member> or
99cdf0e10cSrcweir        <member>SymbolStyle::POLYGON</member>.</p>
100cdf0e10cSrcweir     */
101cdf0e10cSrcweir    long 												BorderColor;
102cdf0e10cSrcweir
103cdf0e10cSrcweir    /** The color used for filling symbols that contain closed polygons.
104cdf0e10cSrcweir
105cdf0e10cSrcweir        <p>Only effective if <member>Style</member> is
106cdf0e10cSrcweir        <member>SymbolStyle::AUTO</member>,
107cdf0e10cSrcweir        <member>SymbolStyle::STANDARD</member> or
108cdf0e10cSrcweir        <member>SymbolStyle::POLYGON</member>.</p>
109cdf0e10cSrcweir     */
110cdf0e10cSrcweir    long 												FillColor;
111cdf0e10cSrcweir};
112cdf0e10cSrcweir
113cdf0e10cSrcweir//=============================================================================
114cdf0e10cSrcweir
115cdf0e10cSrcweir}; }; }; };
116cdf0e10cSrcweir
117cdf0e10cSrcweir#endif
118cdf0e10cSrcweir
119