offapi/com/sun/star/chart2/XDiagram.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef com_sun_star_chart2_XDiagram_idl
  29 #define com_sun_star_chart2_XDiagram_idl
  30
  31 #include <com/sun/star/uno/XInterface.idl>
  32 #include <com/sun/star/beans/XPropertySet.idl>
  33 #include <com/sun/star/beans/PropertyValue.idl>
  34 #include <com/sun/star/chart2/XLegend.idl>
  35 #include <com/sun/star/chart2/XColorScheme.idl>
  36 #include <com/sun/star/chart2/data/XDataSource.idl>
  37 #include <com/sun/star/chart2/data/XLabeledDataSequence.idl>
  38
  39 module com
  40 {
  41 module sun
  42 {
  43 module star
  44 {
  45 module chart2
  46 {
  47
  48 interface XDiagram : ::com::sun::star::uno::XInterface
  49 {
  50     /** returns the property set that determines the visual appearance
  51         of the wall.
  52
  53         <p>The wall is the area behind the union of all
  54         coordinate systems used in a diagram.</p>
  55      */
  56     com::sun::star::beans::XPropertySet getWall();
  57
  58     /** returns the property set that determines the visual appearance
  59         of the floor if any.
  60
  61         <p>The floor is the bottom of a 3D diagram.
  62         For a 2D diagram NULL is returned.</p>
  63      */
  64     com::sun::star::beans::XPropertySet getFloor();
  65
  66     /** returns the legend, which may represent data series and other
  67         information about a diagram in a separate box.
  68      */
  69     XLegend getLegend();
  70
  71     /** sets a new legend.
  72      */
  73     void setLegend( [in] XLegend xLegend );
  74
  75     /** returns an <type>XColorScheme</type> that defines the default
  76         colors for data series (or data points) in the diagram.
  77      */
  78     XColorScheme   getDefaultColorScheme();
  79
  80     /** sets an <type>XColorScheme</type> that defines the default
  81         colors for data series (or data points) in the diagram.
  82      */
  83     void setDefaultColorScheme( [in] XColorScheme xColorScheme );
  84
  85     /** sets new data to the diagram.
  86
  87         @param xDataSource
  88             This data source will be interpreted in a chart-type
  89             specific way and the <type>DataSeries</type> found in
  90             <code>xDiagram</code> will be adapted to the new data.
  91             Missing data series will be created and unused ones will
  92             be deleted.
  93
  94         @param aArguments
  95             Arguments tells how to slice the given data.
  96
  97             <p>For standard parameters that may be used, see the
  98             service <type>StandardDiagramCreationParameters</type>.
  99             </p>
 100      */
 101     void setDiagramData( [in] com::sun::star::chart2::data::XDataSource xDataSource,
 102         [in] sequence< com::sun::star::beans::PropertyValue > aArguments );
 103 };
 104
 105 } ; // chart2
 106 } ; // com
 107 } ; // sun
 108 } ; // star
 109
 110 #endif
 111
 112 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */