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
24#ifndef __com_sun_star_sheet_SubTotalDescriptor_idl__
25#define __com_sun_star_sheet_SubTotalDescriptor_idl__
26
27#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__
28#include <com/sun/star/sheet/XSubTotalDescriptor.idl>
29#endif
30
31#ifndef __com_sun_star_beans_XPropertySet_idl__
32#include <com/sun/star/beans/XPropertySet.idl>
33#endif
34#ifndef __com_sun_star_container_XEnumerationAccess_idl__
35#include <com/sun/star/container/XEnumerationAccess.idl>
36#endif
37#ifndef __com_sun_star_container_XIndexAccess_idl__
38#include <com/sun/star/container/XIndexAccess.idl>
39#endif
40
41//=============================================================================
42
43module com {  module sun {  module star {  module sheet {
44
45//=============================================================================
46
47/** represents a description of how subtotals are created.
48
49	<p>The descriptor contains properties and a collection of subtotal fields
50	which control the behaviour of operation.</p>
51 */
52published service SubTotalDescriptor
53{
54	//-------------------------------------------------------------------------
55
56	/** provides access to the collection of subtotal fields.
57	 */
58	interface com::sun::star::sheet::XSubTotalDescriptor;
59
60	//-------------------------------------------------------------------------
61
62	/** creates an enumeration of all sub total fields.
63
64		@see com::sun::star::sheet::SubTotalFieldsEnumeration
65	 */
66	interface com::sun::star::container::XEnumerationAccess;
67
68	//-------------------------------------------------------------------------
69
70	/** provides access to the sub total fields in the collection via index.
71	 */
72	interface com::sun::star::container::XIndexAccess;
73
74	//-------------------------------------------------------------------------
75
76//!published service PropertySet
77	/** procides access to the properties.
78	 */
79	interface com::sun::star::beans::XPropertySet;
80
81	//=========================================================================
82
83	/** specifies if page breaks are inserted after each group change.
84	 */
85	[property] boolean InsertPageBreaks;
86
87	//-------------------------------------------------------------------------
88
89	/** specifies if the case of letters is important when comparing entries.
90	 */
91	[property] boolean IsCaseSensitive;
92
93	//-------------------------------------------------------------------------
94
95	/** specifies if a user defined sorting list is used.
96	 */
97	[property] boolean EnableUserSortList;
98
99	//-------------------------------------------------------------------------
100
101	/** specifies which user defined sorting list is used.
102
103		<p>This property is only used if
104		<member>SubTotalDescriptor::EnableUserSortList</member>
105		is <TRUE/>.</p>
106	 */
107	[property] long UserSortListIndex;
108
109	//-------------------------------------------------------------------------
110
111	/** specifies if cell formats are moved with the contents they belong to.
112	 */
113	[property] boolean BindFormatsToContent;
114
115	//-------------------------------------------------------------------------
116
117	/** specifies if the contents of the fields will be sorted to groups
118		while performing a subtotal operation.
119	 */
120	[property] boolean EnableSort;
121
122	//-------------------------------------------------------------------------
123
124	/** specifies the sorting order if
125		<member>SubTotalDescriptor::EnableSort</member> is set to <TRUE/>.
126	 */
127	[property] boolean SortAscending;
128
129	//-------------------------------------------------------------------------
130
131	/** returns the maximum number of subtotal fields the descriptor can
132		hold.
133
134		<p>This read-only property indicates the maximum count of fields the
135		current implementation supports.</p>
136	 */
137	[readonly, property] long MaxFieldCount;
138
139};
140
141//=============================================================================
142
143}; }; }; };
144
145#endif
146
147