offapi/com/sun/star/chart2/XInternalDataProvider.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: XInternalDataProvider.idl,v $
  10  * $Revision: 1.4 $
  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_chart2_XInternalDataProvider_idl
  31 #define com_sun_star_chart2_XInternalDataProvider_idl
  32
  33 #include <com/sun/star/chart2/data/XDataProvider.idl>
  34 #include <com/sun/star/chart2/data/XDataSequence.idl>
  35
  36 module com
  37 {
  38 module sun
  39 {
  40 module star
  41 {
  42 module chart2
  43 {
  44
  45 /** An internal DataProvider that has more access to data that a plain
  46     DataProvider.
  47  */
  48 interface XInternalDataProvider  : com::sun::star::chart2::data::XDataProvider
  49 {
  50     boolean         hasDataByRangeRepresentation( [in] string aRange );
  51     sequence< any > getDataByRangeRepresentation( [in] string aRange );
  52     void            setDataByRangeRepresentation( [in] string aRange, [in] sequence< any > aNewData );
  53
  54     /** @param Note that -1 is allowed as the sequence is inserted
  55                after the given index. So to insert a sequence as the
  56                new first sequence (index 0), you would pass -1 here.
  57      */
  58     void insertSequence( [in] long nAfterIndex );
  59     void deleteSequence( [in] long nAtIndex );
  60     /** same as insertSequence with nAfterIndex being the largest
  61         current index of the data, i.e. (size - 1)
  62      */
  63     void appendSequence();
  64
  65     void insertDataPointForAllSequences( [in] long nAfterIndex );
  66     void deleteDataPointForAllSequences( [in] long nAtIndex );
  67     void swapDataPointWithNextOneForAllSequences( [in] long nAtIndex );
  68
  69     /** If range representations of data sequences change due to
  70         internal structural changes, they must be registered at the
  71         data provider.
  72
  73         <p>Sequences that are directly retrieved via the methods of
  74         the XDataProvider interface are already registered.  If a
  75         labeled data sequence was created by cloning an existing one,
  76         it has to be explicitly registered via this method.</p>
  77      */
  78     void registerDataSequenceForChanges( [in] data::XDataSequence xSeq );
  79 };
  80
  81 } ; // chart2
  82 } ; // com
  83 } ; // sun
  84 } ; // star
  85
  86
  87 #endif