offapi/com/sun/star/chart/Diagram.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: Diagram.idl,v $
  10  * $Revision: 1.14.92.2 $
  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_Diagram_idl__
  31 #define __com_sun_star_chart_Diagram_idl__
  32
  33 #ifndef __com_sun_star_chart_XDiagram_idl__
  34 #include <com/sun/star/chart/XDiagram.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_chart_ChartDataRowSource_idl__
  42 #include <com/sun/star/chart/ChartDataRowSource.idl>
  43 #endif
  44
  45 #ifndef _com_sun_star_xml_UserDefinedAttributeSupplier_idl_
  46 #include <com/sun/star/xml/UserDefinedAttributeSupplier.idl>
  47 #endif
  48
  49 //=============================================================================
  50
  51  module com {  module sun {  module star {  module chart {
  52
  53 //=============================================================================
  54
  55 /** the base service for the diagram of the chart document.
  56
  57     <p>The diagram is the object that contains the actual plot.</p>
  58
  59     <p>Different Diagram Types, e.g., <type>PieDiagram</type> or
  60     <type>LineDiagram</type>, can be instantiated by the
  61     <type scope="com::sun::star::lang">XMultiServiceFactory</type> of
  62     the <type>XChartDocument</type>.</p>
  63
  64  */
  65 published service Diagram
  66 {
  67
  68     interface com::sun::star::chart::XDiagram;
  69
  70     //-------------------------------------------------------------------------
  71
  72     /** If this property is <TRUE/> the position is calculated by the application automatically.
  73         Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
  74         to set a concrete position (note <type scope="com::sun::star::chart">XDiagram</type> is derived from <type scope="com::sun::star::drawing">XShape</type>).
  75      */
  76     [optional, property] boolean AutomaticPosition;
  77
  78     //-------------------------------------------------------------------------
  79
  80     /** If this property is <TRUE/> the size is calculated by the application automatically.
  81         Setting this property to false will have no effect. Instead use the interface <type scope="com::sun::star::drawing">XShape</type>
  82         to set a concrete size (note <type scope="com::sun::star::chart">XDiagram</type> is derived from <type scope="com::sun::star::drawing">XShape</type>).
  83      */
  84     [optional, property] boolean AutomaticSize;
  85
  86     //-------------------------------------------------------------------------
  87
  88     interface com::sun::star::beans::XPropertySet;
  89
  90     //-------------------------------------------------------------------------
  91
  92     /** If a <type>Diagram</type> may be stored as XML file, this
  93         service should be supported in order to preserve unparsed XML
  94         attributes.
  95
  96     @since OOo 1.1.2
  97      */
  98     [optional] service com::sun::star::xml::UserDefinedAttributeSupplier;
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** determines if the data for a data row is contained in the
 103         columns or in the rows of the data array.
 104
 105         @see ChartDataRowSource
 106         @see ChartDataArray
 107      */
 108     [property] com::sun::star::chart::ChartDataRowSource DataRowSource;
 109
 110     //-------------------------------------------------------------------------
 111
 112     /** specifies how the caption of data points is displayed.
 113
 114         @see ChartDataCaption
 115      */
 116     [property] long DataCaption;
 117
 118     //-------------------------------------------------------------------------
 119
 120     /** specifies how empty or invalid cells in the provided data should be handled when displayed
 121
 122         @see MissingValueTreatment
 123      */
 124     [optional, property] long MissingValueTreatment;
 125
 126 };
 127
 128 //=============================================================================
 129
 130 }; }; }; };
 131
 132 #endif