AOO410/main/offapi/com/sun/star/chart2/XChartType.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 * 
 *************************************************************/

#ifndef com_sun_star_chart2_XChartType_idl
#define com_sun_star_chart2_XChartType_idl

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#include <com/sun/star/chart2/XCoordinateSystem.idl>

module com
{
module sun
{
module star
{
module chart2
{

/**
 */
interface XChartType : com::sun::star::uno::XInterface
{
    /** A string representation of the chart type.
        This needs to be the service-name which can be used to create a charttype.
     */
    string getChartType();

    /** Creates a coordinate systems that fits the chart-type with its
        current settings and for the given dimension.

        @throws IllegalArgumentException
            This charttype cannot be displayed in the given dimension.
     */
    XCoordinateSystem createCoordinateSystem( [in] long DimensionCount )
        raises( com::sun::star::lang::IllegalArgumentException );

    /** Returns a sequence of roles that are undestood by this chart
        type.

        <p>All roles must be listed in the order in which they are
        usually parsed.  This ensures that glueing sequences together
        and splitting them up apart again results in the same
        structure as before.</p>

        <p>Note, that this does not involve optional roles, like
        error-bars.</p>
     */
    sequence< string >   getSupportedMandatoryRoles();

    /** Returns a sequence of roles that are understood in addition to
        the mandatory roles (see
        <member>XChartType::getSupportedMandatoryRoles()</member>).

        <p>An example for an optional role are error-bars.</p>
     */
    sequence< string >   getSupportedOptionalRoles();

    /** Returns the role of the <type>XLabeledDataSequence</type> of
        which the label will be taken to identify the
        <type>DataSeries</type> in dialogs or the legend.
     */
    string getRoleOfSequenceForSeriesLabel();
};

} ; // chart2
} ; // com
} ; // sun
} ; // star


#endif