summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/SubTotalDescriptor.idl
blob: 443d73a19c0faa02a8d7e3b9e3504e92ddc9149d (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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 * 
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: SubTotalDescriptor.idl,v $
 * $Revision: 1.8 $
 *
 * 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_SubTotalDescriptor_idl__
#define __com_sun_star_sheet_SubTotalDescriptor_idl__

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

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_container_XEnumerationAccess_idl__
#include <com/sun/star/container/XEnumerationAccess.idl>
#endif
#ifndef __com_sun_star_container_XIndexAccess_idl__
#include <com/sun/star/container/XIndexAccess.idl>
#endif

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

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

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

/** represents a description of how subtotals are created.

    <p>The descriptor contains properties and a collection of subtotal fields
    which control the behaviour of operation.</p>
 */
published service SubTotalDescriptor
{
    //-------------------------------------------------------------------------

    /** provides access to the collection of subtotal fields.
     */
    interface com::sun::star::sheet::XSubTotalDescriptor;

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

    /** creates an enumeration of all sub total fields.

        @see com::sun::star::sheet::SubTotalFieldsEnumeration
     */
    interface com::sun::star::container::XEnumerationAccess;

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

    /** provides access to the sub total fields in the collection via index.
     */
    interface com::sun::star::container::XIndexAccess;

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

//!published service PropertySet
    /** procides access to the properties.
     */
    interface com::sun::star::beans::XPropertySet;

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

    /** specifies if page breaks are inserted after each group change.
     */
    [property] boolean InsertPageBreaks;

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

    /** specifies if the case of letters is important when comparing entries.
     */
    [property] boolean IsCaseSensitive;

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

    /** specifies if a user defined sorting list is used.
     */
    [property] boolean EnableUserSortList;

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

    /** specifies which user defined sorting list is used.

        <p>This property is only used if
        <member>SubTotalDescriptor::EnableUserSortList</member>
        is <TRUE/>.</p>
     */
    [property] long UserSortListIndex;

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

    /** specifies if cell formats are moved with the contents they belong to.
     */
    [property] boolean BindFormatsToContent;

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

    /** specifies if the contents of the fields will be sorted to groups
        while performing a subtotal operation.
     */
    [property] boolean EnableSort;

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

    /** specifies the sorting order if
        <member>SubTotalDescriptor::EnableSort</member> is set to <TRUE/>.
     */
    [property] boolean SortAscending;

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

    /** returns the maximum number of subtotal fields the descriptor can
        hold.

        <p>This read-only property indicates the maximum count of fields the
        current implementation supports.</p>
     */
    [readonly, property] long MaxFieldCount;

};

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

}; }; }; };

#endif