1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir#ifndef com_sun_star_chart2_data_DataSequence_idl 28*cdf0e10cSrcweir#define com_sun_star_chart2_data_DataSequence_idl 29*cdf0e10cSrcweir 30*cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl> 31*cdf0e10cSrcweir#include <com/sun/star/container/XIndexReplace.idl> 32*cdf0e10cSrcweir#include <com/sun/star/util/XCloneable.idl> 33*cdf0e10cSrcweir#include <com/sun/star/util/XModifyBroadcaster.idl> 34*cdf0e10cSrcweir 35*cdf0e10cSrcweir#include <com/sun/star/chart2/data/XDataSequence.idl> 36*cdf0e10cSrcweir#include <com/sun/star/chart2/data/XNumericalDataSequence.idl> 37*cdf0e10cSrcweir#include <com/sun/star/chart2/data/XTextualDataSequence.idl> 38*cdf0e10cSrcweir 39*cdf0e10cSrcweir#include <com/sun/star/chart2/data/DataSequenceRole.idl> 40*cdf0e10cSrcweir 41*cdf0e10cSrcweirmodule com 42*cdf0e10cSrcweir{ 43*cdf0e10cSrcweirmodule sun 44*cdf0e10cSrcweir{ 45*cdf0e10cSrcweirmodule star 46*cdf0e10cSrcweir{ 47*cdf0e10cSrcweirmodule chart2 48*cdf0e10cSrcweir{ 49*cdf0e10cSrcweirmodule data 50*cdf0e10cSrcweir{ 51*cdf0e10cSrcweir 52*cdf0e10cSrcweir/** describes a container for a sequence of values. 53*cdf0e10cSrcweir 54*cdf0e10cSrcweir <p>With the interface <type>XDataSequence</type> it is possible to 55*cdf0e10cSrcweir transfer a complete sequence of values. 56*cdf0e10cSrcweir 57*cdf0e10cSrcweir <p>With the optional 58*cdf0e10cSrcweir <type scope="com::sun::star::container">XIndexReplace</type> it is 59*cdf0e10cSrcweir possible to modify single elements, if the corresponding 60*cdf0e10cSrcweir <type>DataProvider</type> supports modification of its values.</p> 61*cdf0e10cSrcweir */ 62*cdf0e10cSrcweirservice DataSequence 63*cdf0e10cSrcweir{ 64*cdf0e10cSrcweir /** provides read- and write-access to the underlying data. 65*cdf0e10cSrcweir */ 66*cdf0e10cSrcweir interface XDataSequence; 67*cdf0e10cSrcweir 68*cdf0e10cSrcweir /** you may implement this interface to allow a fast acces to 69*cdf0e10cSrcweir numerical data. With this interface you can get a 70*cdf0e10cSrcweir <atom>sequence</atom> of <atom>double</atom> values. 71*cdf0e10cSrcweir */ 72*cdf0e10cSrcweir [optional] interface XNumericalDataSequence; 73*cdf0e10cSrcweir 74*cdf0e10cSrcweir /** you may implement this interface to allow a fast acces to 75*cdf0e10cSrcweir textual data. With this interface you can get a 76*cdf0e10cSrcweir <atom>sequence</atom> of <atom>string</atom> values. 77*cdf0e10cSrcweir */ 78*cdf0e10cSrcweir [optional] interface XTextualDataSequence; 79*cdf0e10cSrcweir 80*cdf0e10cSrcweir /** provides read- and write-access to single elements of the 81*cdf0e10cSrcweir underlying data. 82*cdf0e10cSrcweir 83*cdf0e10cSrcweir <p>Only when supporting this interface, it is possible for 84*cdf0e10cSrcweir client applications to modify the content of the data that is 85*cdf0e10cSrcweir provided by this <type>DataSequence</type>.</p> 86*cdf0e10cSrcweir */ 87*cdf0e10cSrcweir [optional] interface ::com::sun::star::container::XIndexReplace; 88*cdf0e10cSrcweir 89*cdf0e10cSrcweir /** Allows creating copies of data sequences. If this interface 90*cdf0e10cSrcweir is not supported, the same object will be shared if used by 91*cdf0e10cSrcweir multiple objects. 92*cdf0e10cSrcweir 93*cdf0e10cSrcweir <p>Cloning is especially useful when using identifiers. A 94*cdf0e10cSrcweir cloned data sequence will get a new identifier while the 95*cdf0e10cSrcweir source range representation is identical to the original 96*cdf0e10cSrcweir one.</p> 97*cdf0e10cSrcweir 98*cdf0e10cSrcweir <p>Note that, when this interface is not implemented the 99*cdf0e10cSrcweir releasing of identifiers at the <type>XDataProvider</type> 100*cdf0e10cSrcweir will not work properly, because more than one object may use 101*cdf0e10cSrcweir the same identifier. So, when an object releases the 102*cdf0e10cSrcweir identifier, another object might use a stale identifier.</p> 103*cdf0e10cSrcweir */ 104*cdf0e10cSrcweir [optional] interface ::com::sun::star::util::XCloneable; 105*cdf0e10cSrcweir 106*cdf0e10cSrcweir /** is used to broadcast change events whenever the content (data) 107*cdf0e10cSrcweir or the range representations change. 108*cdf0e10cSrcweir */ 109*cdf0e10cSrcweir interface com::sun::star::util::XModifyBroadcaster; 110*cdf0e10cSrcweir 111*cdf0e10cSrcweir /** the property interface by which the properties of all 112*cdf0e10cSrcweir supported services are exchanged 113*cdf0e10cSrcweir */ 114*cdf0e10cSrcweir interface ::com::sun::star::beans::XPropertySet; 115*cdf0e10cSrcweir 116*cdf0e10cSrcweir // ---------------------------------------------------------------------- 117*cdf0e10cSrcweir 118*cdf0e10cSrcweir /** The key (index) of the number format that this sequence should 119*cdf0e10cSrcweir be formatted with. 120*cdf0e10cSrcweir 121*cdf0e10cSrcweir <p>The key identifies a number format in an 122*cdf0e10cSrcweir <type scope="com::sun::star::util">XNumberFormats</type> 123*cdf0e10cSrcweir object. This object can be retrieved by the 124*cdf0e10cSrcweir <type scope="com::sun::star::util">XNumberFormatsSupplier</type> 125*cdf0e10cSrcweir interface supported by 126*cdf0e10cSrcweir <type scope="com::sun::star::chart">ChartDocument</type>.</p> 127*cdf0e10cSrcweir 128*cdf0e10cSrcweir @todo use proper number format instead of a transient key. 129*cdf0e10cSrcweir */ 130*cdf0e10cSrcweir// [optional, property] long NumberFormatKey; 131*cdf0e10cSrcweir 132*cdf0e10cSrcweir /** The role of the series inside a data series. This may be any 133*cdf0e10cSrcweir string. However some strings are predefined and should always 134*cdf0e10cSrcweir be used in the same way. 135*cdf0e10cSrcweir 136*cdf0e10cSrcweir @see DataSequenceRole 137*cdf0e10cSrcweir */ 138*cdf0e10cSrcweir [property] DataSequenceRole Role; 139*cdf0e10cSrcweir 140*cdf0e10cSrcweir /** If set to false <FALSE/>, values from hidden cells are not returned. 141*cdf0e10cSrcweir */ 142*cdf0e10cSrcweir [optional, property] boolean IncludeHiddenCells; 143*cdf0e10cSrcweir 144*cdf0e10cSrcweir /** a sequence of indexes that identify values that are hidden in the underlying 145*cdf0e10cSrcweir data provider. 146*cdf0e10cSrcweir */ 147*cdf0e10cSrcweir [optional, property] sequence< long > HiddenValues; 148*cdf0e10cSrcweir}; 149*cdf0e10cSrcweir 150*cdf0e10cSrcweir} ; // data 151*cdf0e10cSrcweir} ; // chart2 152*cdf0e10cSrcweir} ; // com 153*cdf0e10cSrcweir} ; // sun 154*cdf0e10cSrcweir} ; // star 155*cdf0e10cSrcweir 156*cdf0e10cSrcweir 157*cdf0e10cSrcweir#endif 158