offapi/com/sun/star/chart/XChartDocument.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XChartDocument.idl,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_chart_XChartDocument_idl__
  31 #define __com_sun_star_chart_XChartDocument_idl__
  32
  33 #ifndef __com_sun_star_frame_XModel_idl__
  34 #include <com/sun/star/frame/XModel.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_drawing_XShape_idl__
  38 #include <com/sun/star/drawing/XShape.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XPropertySet_idl__
  42 #include <com/sun/star/beans/XPropertySet.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_chart_XDiagram_idl__
  46 #include <com/sun/star/chart/XDiagram.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_chart_XChartData_idl__
  50 #include <com/sun/star/chart/XChartData.idl>
  51 #endif
  52
  53
  54 //=============================================================================
  55
  56  module com {  module sun {  module star {  module chart {
  57
  58 //=============================================================================
  59
  60 /** manages the chart document.
  61
  62     @see XDiagram
  63     @see XChartData
  64  */
  65 published interface XChartDocument: com::sun::star::frame::XModel
  66 {
  67     //-------------------------------------------------------------------------
  68
  69     /** @returns
  70             the shape of the main title of the chart document.
  71
  72         @see ChartTitle
  73      */
  74     com::sun::star::drawing::XShape getTitle();
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** @returns
  79             the shape of the subtitle of the chart document.
  80
  81        <p>Usually the subtitle is smaller than the main title by
  82        default.  And it is most commonly placed below the main title
  83        by default.</p>
  84
  85         @see ChartTitle
  86      */
  87     com::sun::star::drawing::XShape getSubTitle();
  88
  89     //-------------------------------------------------------------------------
  90
  91     /** @returns
  92             the shape of the legend of the chart document.
  93
  94         @see ChartLegend
  95      */
  96     com::sun::star::drawing::XShape getLegend();
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** @returns
 101             the properties of the background area of the chart document.
 102
 103         <p>The area's extent is equal to the document size.  If you
 104         want to access properties of the background area of the
 105         diagram, in which the actual data is represented, you have to
 106         change the chart wall which you get from the
 107         <type>X3DDisplay</type>.</p>
 108
 109         @see ChartArea
 110         @see X3DDisplay
 111      */
 112     com::sun::star::beans::XPropertySet getArea();
 113
 114     //-------------------------------------------------------------------------
 115
 116     /** @returns
 117             the diagram of the chart document.
 118
 119         @see Diagram
 120      */
 121     com::sun::star::chart::XDiagram getDiagram();
 122
 123     //-------------------------------------------------------------------------
 124
 125     /** sets the diagram for the chart document.
 126
 127         <p>Setting a new diagram implicitly disposes the previous
 128         diagram.</p>
 129
 130         @param xDiagram
 131             the new diagram that should be set for the chart.  To
 132             create such a diagram component, you can use the
 133             <type scope="com::sun::star::lang">XMultiServiceFactory</type>,
 134             which should be implemented by an
 135             <type>XChartDocument</type>.
 136      */
 137     void setDiagram( [in] com::sun::star::chart::XDiagram xDiagram );
 138
 139     //-------------------------------------------------------------------------
 140
 141     /** @returns
 142             the data source of the chart.
 143
 144         @see ChartData
 145      */
 146     com::sun::star::chart::XChartData getData();
 147
 148     //-------------------------------------------------------------------------
 149
 150     /** attaches an external data source to the chart.
 151
 152         @see ChartData
 153
 154         @param xData
 155             the component that provides the new data.
 156      */
 157     void attachData( [in] com::sun::star::chart::XChartData xData );
 158
 159 };
 160
 161 //=============================================================================
 162
 163 }; }; }; };
 164
 165 #endif