summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/chart2/XAnyDescriptionAccess.idl
blob: e0803c4a0f187f397799af1fada356fb8a559aff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_chart2_XAnyDescriptionAccess_idl__
#define __com_sun_star_chart2_XAnyDescriptionAccess_idl__

#include <com/sun/star/chart/XComplexDescriptionAccess.idl>

//=============================================================================

 module com {  module sun {  module star {  module chart2 {

//=============================================================================

/** Offers any access to column and row descriptions.
This allows to set date values as categories.

<p>Can be obtained from interface <type>XChartDocument</type> via method getData().</p>

@since OOo 3.4
*/

interface XAnyDescriptionAccess : ::com::sun::star::chart::XComplexDescriptionAccess
{
    //-------------------------------------------------------------------------

    /** retrieves the descriptions for all rows.

        @returns
            a sequence of sequences of anys representing the descriptions
            of all rows. The outer index represents different rows.
            The inner index represents the different levels (usually there is only one).
            The any might be strings for category text axis or doubles for date axis.
     */
    sequence< sequence< any > > getAnyRowDescriptions();

    //-------------------------------------------------------------------------

    /** sets the descriptions for all rows.

        @param rRowDescriptions
            a sequence of sequences of anys representing the descriptions of all
            rows. The outer index represents different rows.
            The inner index represents the different levels (usually there is only one).
            The any might be strings for category text axis or doubles for date axis.
    */
    void setAnyRowDescriptions( [in] sequence< sequence< any > > rRowDescriptions );

    //-------------------------------------------------------------------------

    /** retrieves the descriptions for all columns.

        @returns
            a sequence of sequences of anys representing the descriptions
            of all columns. The outer index represents different columns.
            The inner index represents the different levels (usually there is only one).
            The any might be strings for category text axis or doubles for date axis.
     */
    sequence< sequence< any > > getAnyColumnDescriptions();

    //-------------------------------------------------------------------------

    /** sets the descriptions for all columns.

        @param rColumnDescriptions
            a sequence of sequences of anys which represent the descriptions of
            all columns. The outer index represents different columns.
            The inner index represents the different levels (usually there is only one).
            The any might be strings for category text axis or doubles for date axis.
     */
    void setAnyColumnDescriptions( [in] sequence< sequence< any > > rColumnDescriptions );
};

//=============================================================================

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */