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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef com_sun_star_chart2_XInternalDataProvider_idl
  20 #define com_sun_star_chart2_XInternalDataProvider_idl
  21
  22 #include <com/sun/star/chart2/data/XDataProvider.idl>
  23 #include <com/sun/star/chart2/data/XDataSequence.idl>
  24
  25 module com
  26 {
  27 module sun
  28 {
  29 module star
  30 {
  31 module chart2
  32 {
  33
  34 /** An internal DataProvider that has more access to data than a plain
  35     DataProvider.
  36  */
  37 interface XInternalDataProvider  : com::sun::star::chart2::data::XDataProvider
  38 {
  39     boolean         hasDataByRangeRepresentation( [in] string aRange );
  40     sequence< any > getDataByRangeRepresentation( [in] string aRange );
  41     void            setDataByRangeRepresentation( [in] string aRange, [in] sequence< any > aNewData );
  42
  43     /** @note  Note that -1 is allowed as the sequence is inserted
  44                after the given index. So to insert a sequence as the
  45                new first sequence (index 0), you would pass -1 here.
  46      */
  47     void insertSequence( [in] long nAfterIndex );
  48     void deleteSequence( [in] long nAtIndex );
  49     /** same as insertSequence with nAfterIndex being the largest
  50         current index of the data, i.e. (size - 1)
  51      */
  52     void appendSequence();
  53
  54     void insertDataPointForAllSequences( [in] long nAfterIndex );
  55     void deleteDataPointForAllSequences( [in] long nAtIndex );
  56     void swapDataPointWithNextOneForAllSequences( [in] long nAtIndex );
  57
  58     /** If range representations of data sequences change due to
  59         internal structural changes, they must be registered at the
  60         data provider.
  61
  62         <p>Sequences that are directly retrieved via the methods of
  63         the XDataProvider interface are already registered.  If a
  64         labeled data sequence was created by cloning an existing one,
  65         it has to be explicitly registered via this method.</p>
  66      */
  67     void registerDataSequenceForChanges( [in] com::sun::star::chart2::data::XDataSequence xSeq );
  68
  69     /** insert an additional sequence for categories nLevel>=1;
  70     categories at level 0 are always present and cannot be inserted or deleted
  71     @since OOo 3.3
  72     */
  73     void insertComplexCategoryLevel( [in] long nLevel );
  74     /** deletes an additional sequence for categories at nLevel>=1;
  75     categories at level 0 are always present and cannot be deleted
  76     @since OOo 3.3
  77     */
  78     void deleteComplexCategoryLevel( [in] long nLevel );
  79 };
  80
  81 } ; // chart2
  82 } ; // com
  83 } ; // sun
  84 } ; // star
  85
  86
  87 #endif
  88
  89 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */