xref: /trunk/main/offapi/com/sun/star/chart/ChartSymbolType.idl (revision ffd38472365e95f6a578737bc9a5eb0fac624a86)
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_chart_ChartSymbolType_idl__
24#define __com_sun_star_chart_ChartSymbolType_idl__
25
26
27//=============================================================================
28
29 module com {  module sun {  module star {  module chart {
30
31//=============================================================================
32
33/** These values specify the type of the symbol used for data points.
34
35    <p>This only applies to diagrams that use symbols like line
36    diagrams.</p>
37
38    <p>The default symbols are currently:
39     <table border >
40      <tr><td>Symbol 0</td><td>a square</td></tr>
41      <tr><td>Symbol 1</td><td>a diamond</td></tr>
42      <tr><td>Symbol 2</td><td>a triangle pointing down</td></tr>
43      <tr><td>Symbol 3</td><td>a triangle pointing up</td></tr>
44      <tr><td>Symbol 4</td><td>a triangle pointing right</td></tr>
45      <tr><td>Symbol 5</td><td>a triangle pointing left</td></tr>
46      <tr><td>Symbol 6</td><td>a bow tie</td></tr>
47      <tr><td>Symbol 7</td><td>a rotated bow tie</td></tr>
48     </table>
49    </p>
50
51    @see LineDiagram
52    @see ChartDataPointProperties
53*/
54published constants ChartSymbolType
55{
56    //-------------------------------------------------------------------------
57
58    /** No symbol is used.
59     */
60    const long NONE = -3;
61
62    //-------------------------------------------------------------------------
63
64    /** The symbol is selected automatically.  The size of symbol will
65        be dynamic and the type depends on the data row number.
66     */
67    const long AUTO = -2;
68
69    //-------------------------------------------------------------------------
70
71    /** Take a Bitmap from a URL and use this as symbol.
72
73        <p>The bitmap given by the URL set in the property
74        <member>ChartDataPointProperties::SymbolBitmapURL</member> is
75        copied so that the graphic is embedded.</p>
76
77        @see ChartDataPointProperties
78     */
79    const long BITMAPURL = -1;
80
81    //-------------------------------------------------------------------------
82
83    /** The default symbol for row 0 is used.
84     */
85    const long SYMBOL0 = 0;
86
87    //-------------------------------------------------------------------------
88
89    /** The default symbol for row 1 is used.
90     */
91    const long SYMBOL1 = 1;
92
93    //-------------------------------------------------------------------------
94
95    /** The default symbol for row 2 is used.
96     */
97    const long SYMBOL2 = 2;
98
99    //-------------------------------------------------------------------------
100
101    /** The default symbol for row 3 is used.
102     */
103    const long SYMBOL3 = 3;
104
105    //-------------------------------------------------------------------------
106
107    /** The default symbol for row 4 is used.
108     */
109    const long SYMBOL4 = 4;
110
111    //-------------------------------------------------------------------------
112
113    /** The default symbol for row 5 is used.
114     */
115    const long SYMBOL5 = 5;
116
117    //-------------------------------------------------------------------------
118
119    /** The default symbol for row 6 is used.
120     */
121    const long SYMBOL6 = 6;
122
123    //-------------------------------------------------------------------------
124
125    /** The default symbol for row 7 is used.
126     */
127    const long SYMBOL7 = 7;
128
129};
130
131//=============================================================================
132
133}; }; }; };
134
135#endif
136