summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/XDatabaseRange.idl
blob: 573578f0c355143eef6afe4ad973bb95e9ca5e43 (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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
/*************************************************************************
 *
 * 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_sheet_XDatabaseRange_idl__
#define __com_sun_star_sheet_XDatabaseRange_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif

#ifndef __com_sun_star_beans_PropertyValue_idl__
#include <com/sun/star/beans/PropertyValue.idl>
#endif

#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
#include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
#endif

#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__
#include <com/sun/star/sheet/XSubTotalDescriptor.idl>
#endif

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

module com {  module sun {  module star {  module sheet {

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

/** provides access to the settings and options of a database range.

    @see com::sun::star::sheet::DatabaseRange
 */
published interface XDatabaseRange: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** returns the data area of the database range in the
        spreadsheet document.
     */
    com::sun::star::table::CellRangeAddress getDataArea();

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

    /** sets the data area of the database range.
     */
    void setDataArea( [in] com::sun::star::table::CellRangeAddress aDataArea );

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

    /** returns the sort descriptor stored with the database range.

        @see com::sun::star::sheet::SheetSortDescriptor2
     */
    sequence< com::sun::star::beans::PropertyValue > getSortDescriptor();

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

    /** returns the filter descriptor stored with the database range.

        <p>If the filter descriptor is modified, the new filtering is
        carried out when <member>XDatabaseRange::refresh()</member> is
        called.</p>
     */
    com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor();

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

    /** returns the subtotal descriptor stored with the database range.

        <p>If the subtotal descriptor is modified, the new subtotals are
        inserted when <member>XDatabaseRange::refresh()</member> is
        called.</p>
     */
    com::sun::star::sheet::XSubTotalDescriptor getSubTotalDescriptor();

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

    /** returns the database import descriptor stored with this database
        range.

        @see com::sun::star::sheet::DatabaseImportDescriptor
     */
    sequence< com::sun::star::beans::PropertyValue > getImportDescriptor();

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

    /** executes the stored import, filter, sorting, and subtotals
        descriptors again.
     */
    void refresh();

};

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

}; }; }; };

#endif