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