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#ifndef com_sun_star_chart2_XChartType_idl
23#define com_sun_star_chart2_XChartType_idl
24
25#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
26#include <com/sun/star/lang/IllegalArgumentException.idl>
27#endif
28
29#ifndef __com_sun_star_uno_XInterface_idl__
30#include <com/sun/star/uno/XInterface.idl>
31#endif
32
33#include <com/sun/star/chart2/XCoordinateSystem.idl>
34
35module com
36{
37module sun
38{
39module star
40{
41module chart2
42{
43
44/**
45 */
46interface XChartType : com::sun::star::uno::XInterface
47{
48    /** A string representation of the chart type.
49        This needs to be the service-name which can be used to create a charttype.
50     */
51    string getChartType();
52
53    /** Creates a coordinate systems that fits the chart-type with its
54        current settings and for the given dimension.
55
56        @throws IllegalArgumentException
57            This charttype cannot be displayed in the given dimension.
58     */
59    XCoordinateSystem createCoordinateSystem( [in] long DimensionCount )
60        raises( com::sun::star::lang::IllegalArgumentException );
61
62    /** Returns a sequence of roles that are undestood by this chart
63        type.
64
65        <p>All roles must be listed in the order in which they are
66        usually parsed.  This ensures that glueing sequences together
67        and splitting them up apart again results in the same
68        structure as before.</p>
69
70        <p>Note, that this does not involve optional roles, like
71        error-bars.</p>
72     */
73    sequence< string >   getSupportedMandatoryRoles();
74
75    /** Returns a sequence of roles that are understood in addition to
76        the mandatory roles (see
77        <member>XChartType::getSupportedMandatoryRoles()</member>).
78
79        <p>An example for an optional role are error-bars.</p>
80     */
81    sequence< string >   getSupportedOptionalRoles();
82
83    /** Returns the role of the <type>XLabeledDataSequence</type> of
84        which the label will be taken to identify the
85        <type>DataSeries</type> in dialogs or the legend.
86     */
87    string getRoleOfSequenceForSeriesLabel();
88};
89
90} ; // chart2
91} ; // com
92} ; // sun
93} ; // star
94
95
96#endif
97