1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef com_sun_star_chart2_XInternalDataProvider_idl
24#define com_sun_star_chart2_XInternalDataProvider_idl
25
26#include <com/sun/star/chart2/data/XDataProvider.idl>
27#include <com/sun/star/chart2/data/XDataSequence.idl>
28
29module com
30{
31module sun
32{
33module star
34{
35module chart2
36{
37
38/** An internal DataProvider that has more access to data than a plain
39    DataProvider.
40 */
41interface XInternalDataProvider  : com::sun::star::chart2::data::XDataProvider
42{
43    boolean         hasDataByRangeRepresentation( [in] string aRange );
44    sequence< any > getDataByRangeRepresentation( [in] string aRange );
45    void            setDataByRangeRepresentation( [in] string aRange, [in] sequence< any > aNewData );
46
47    /** @param Note that -1 is allowed as the sequence is inserted
48               after the given index. So to insert a sequence as the
49               new first sequence (index 0), you would pass -1 here.
50     */
51    void insertSequence( [in] long nAfterIndex );
52    void deleteSequence( [in] long nAtIndex );
53    /** same as insertSequence with nAfterIndex being the largest
54        current index of the data, i.e. (size - 1)
55     */
56    void appendSequence();
57
58    void insertDataPointForAllSequences( [in] long nAfterIndex );
59    void deleteDataPointForAllSequences( [in] long nAtIndex );
60    void swapDataPointWithNextOneForAllSequences( [in] long nAtIndex );
61
62    /** If range representations of data sequences change due to
63        internal structural changes, they must be registered at the
64        data provider.
65
66        <p>Sequences that are directly retrieved via the methods of
67        the XDataProvider interface are already registered.  If a
68        labeled data sequence was created by cloning an existing one,
69        it has to be explicitly registered via this method.</p>
70     */
71    void registerDataSequenceForChanges( [in] data::XDataSequence xSeq );
72
73    /** insert an additional sequence for categories nLevel>=1;
74    categories at level 0 are always present and cannot be inserted or deleted
75    @since OpenOffice 3.3
76    */
77    void insertComplexCategoryLevel( [in] long nLevel );
78    /** deletes an additional sequence for categories at nLevel>=1;
79    categories at level 0 are always present and cannot be deleted
80    @since OpenOffice 3.3
81    */
82    void deleteComplexCategoryLevel( [in] long nLevel );
83};
84
85} ; // chart2
86} ; // com
87} ; // sun
88} ; // star
89
90
91#endif
92