offapi/com/sun/star/chart/ChartDocument.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: ChartDocument.idl,v $
  10  * $Revision: 1.18 $
  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_ChartDocument_idl__
  31 #define __com_sun_star_chart_ChartDocument_idl__
  32
  33 #ifndef __com_sun_star_chart_XChartDocument_idl__
  34 #include <com/sun/star/chart/XChartDocument.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40
  41 #ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
  42 #include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
  43 #endif
  44
  45 // #ifndef com_sun_star_chart2_data_XDataReceiver_idl
  46 // #include <com/sun/star/chart2/data/XDataReceiver.idl>
  47 // #endif
  48
  49 //=============================================================================
  50
  51  module com {  module sun {  module star {  module chart {
  52
  53 //=============================================================================
  54
  55 /** is the service for a chart document.
  56
  57     <p>A chart document consists of a reference to the data source,
  58     the diagram and some additional elements like a main title, a
  59     sub-title or a legend.
  60
  61     </p>@see Diagram
  62         @see ChartLegend
  63         @see ChartTitle
  64         @see ChartDataArray
  65  */
  66 published service ChartDocument
  67 {
  68     /** If a <type>ChartDocument</type> may be stored as XML file,
  69         this service should be supported in order to preserve unparsed
  70         XML attributes.
  71
  72     @since OOo 1.1.2
  73      */
  74     [optional] service ::com::sun::star::xml::UserDefinedAttributeSupplier;
  75
  76     interface ::com::sun::star::chart::XChartDocument;
  77     interface ::com::sun::star::beans::XPropertySet;
  78
  79     /** If this interface is implemented, it is possible to connect
  80         data to a chart via the improved data connection method using
  81         an <type scope="com::sun::star::chart2::data">XDataProvider</type>.
  82      */
  83     // BM: #i32138# XDataReceiver is not yet published
  84 //    [optional] interface ::com::sun::star::chart2::data::XDataReceiver;
  85
  86     //-------------------------------------------------------------------------
  87
  88     /** determines if the main title is shown or hidden.
  89      */
  90     [property] boolean HasMainTitle;
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** determines if the subtitle is shown or hidden.
  95      */
  96     [property] boolean HasSubTitle;
  97
  98     //-------------------------------------------------------------------------
  99
 100     /** determines if the legend is shown or hidden.
 101      */
 102     [property] boolean HasLegend;
 103 };
 104
 105 //=============================================================================
 106
 107 }; }; }; };
 108
 109 #endif