/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XChartDocument.idl,v $
 *
 *  $Revision: 1.12 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-07 22:16:19 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_chart_XChartDocument_idl__
#define __com_sun_star_chart_XChartDocument_idl__

#ifndef __com_sun_star_frame_XModel_idl__
#include <com/sun/star/frame/XModel.idl>
#endif

#ifndef __com_sun_star_drawing_XShape_idl__
#include <com/sun/star/drawing/XShape.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_chart_XDiagram_idl__
#include <com/sun/star/chart/XDiagram.idl>
#endif

#ifndef __com_sun_star_chart_XChartData_idl__
#include <com/sun/star/chart/XChartData.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module chart {

//=============================================================================

/** manages the chart document.

    @see XDiagram
    @see XChartData
 */
published interface XChartDocument: com::sun::star::frame::XModel
{
    //-------------------------------------------------------------------------

    /** @returns
            the shape of the main title of the chart document.

        @see ChartTitle
     */
    com::sun::star::drawing::XShape getTitle();

    //-------------------------------------------------------------------------

    /** @returns
            the shape of the subtitle of the chart document.

       <p>Usually the subtitle is smaller than the main title by
       default.  And it is most commonly placed below the main title
       by default.</p>

        @see ChartTitle
     */
    com::sun::star::drawing::XShape getSubTitle();

    //-------------------------------------------------------------------------

    /** @returns
            the shape of the legend of the chart document.

        @see ChartLegend
     */
    com::sun::star::drawing::XShape getLegend();

    //-------------------------------------------------------------------------

    /** @returns
            the properties of the background area of the chart document.

        <p>The area's extent is equal to the document size.  If you
        want to access properties of the background area of the
        diagram, in which the actual data is represented, you have to
        change the chart wall which you get from the
        <type>X3DDisplay</type>.</p>

        @see ChartArea
        @see X3DDisplay
     */
    com::sun::star::beans::XPropertySet getArea();

    //-------------------------------------------------------------------------

    /** @returns
            the diagram of the chart document.

        @see Diagram
     */
    com::sun::star::chart::XDiagram getDiagram();

    //-------------------------------------------------------------------------

    /** sets the diagram for the chart document.

        <p>Setting a new diagram implicitly disposes the previous
        diagram.</p>

        @param xDiagram
            the new diagram that should be set for the chart.  To
            create such a diagram component, you can use the
            <type scope="com::sun::star::lang">XMultiServiceFactory</type>,
            which should be implemented by an
            <type>XChartDocument</type>.
     */
    void setDiagram( [in] com::sun::star::chart::XDiagram xDiagram );

    //-------------------------------------------------------------------------

    /** @returns
            the data source of the chart.

        @see ChartData
     */
    com::sun::star::chart::XChartData getData();

    //-------------------------------------------------------------------------

    /** attaches an external data source to the chart.

        @see ChartData

        @param xData
            the component that provides the new data.
     */
    void attachData( [in] com::sun::star::chart::XChartData xData );

};

//=============================================================================

}; }; }; };

#endif
