1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_sheet_SubTotalDescriptor_idl__ 25cdf0e10cSrcweir#define __com_sun_star_sheet_SubTotalDescriptor_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__ 28cdf0e10cSrcweir#include <com/sun/star/sheet/XSubTotalDescriptor.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__ 32cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir#ifndef __com_sun_star_container_XEnumerationAccess_idl__ 35cdf0e10cSrcweir#include <com/sun/star/container/XEnumerationAccess.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexAccess_idl__ 38cdf0e10cSrcweir#include <com/sun/star/container/XIndexAccess.idl> 39cdf0e10cSrcweir#endif 40cdf0e10cSrcweir 41cdf0e10cSrcweir//============================================================================= 42cdf0e10cSrcweir 43cdf0e10cSrcweirmodule com { module sun { module star { module sheet { 44cdf0e10cSrcweir 45cdf0e10cSrcweir//============================================================================= 46cdf0e10cSrcweir 47cdf0e10cSrcweir/** represents a description of how subtotals are created. 48cdf0e10cSrcweir 49cdf0e10cSrcweir <p>The descriptor contains properties and a collection of subtotal fields 50cdf0e10cSrcweir which control the behaviour of operation.</p> 51cdf0e10cSrcweir */ 52cdf0e10cSrcweirpublished service SubTotalDescriptor 53cdf0e10cSrcweir{ 54cdf0e10cSrcweir //------------------------------------------------------------------------- 55cdf0e10cSrcweir 56cdf0e10cSrcweir /** provides access to the collection of subtotal fields. 57cdf0e10cSrcweir */ 58cdf0e10cSrcweir interface com::sun::star::sheet::XSubTotalDescriptor; 59cdf0e10cSrcweir 60cdf0e10cSrcweir //------------------------------------------------------------------------- 61cdf0e10cSrcweir 62cdf0e10cSrcweir /** creates an enumeration of all sub total fields. 63cdf0e10cSrcweir 64cdf0e10cSrcweir @see com::sun::star::sheet::SubTotalFieldsEnumeration 65cdf0e10cSrcweir */ 66cdf0e10cSrcweir interface com::sun::star::container::XEnumerationAccess; 67cdf0e10cSrcweir 68cdf0e10cSrcweir //------------------------------------------------------------------------- 69cdf0e10cSrcweir 70cdf0e10cSrcweir /** provides access to the sub total fields in the collection via index. 71cdf0e10cSrcweir */ 72cdf0e10cSrcweir interface com::sun::star::container::XIndexAccess; 73cdf0e10cSrcweir 74cdf0e10cSrcweir //------------------------------------------------------------------------- 75cdf0e10cSrcweir 76cdf0e10cSrcweir//!published service PropertySet 77cdf0e10cSrcweir /** procides access to the properties. 78cdf0e10cSrcweir */ 79cdf0e10cSrcweir interface com::sun::star::beans::XPropertySet; 80cdf0e10cSrcweir 81cdf0e10cSrcweir //========================================================================= 82cdf0e10cSrcweir 83cdf0e10cSrcweir /** specifies if page breaks are inserted after each group change. 84cdf0e10cSrcweir */ 85cdf0e10cSrcweir [property] boolean InsertPageBreaks; 86cdf0e10cSrcweir 87cdf0e10cSrcweir //------------------------------------------------------------------------- 88cdf0e10cSrcweir 89cdf0e10cSrcweir /** specifies if the case of letters is important when comparing entries. 90cdf0e10cSrcweir */ 91cdf0e10cSrcweir [property] boolean IsCaseSensitive; 92cdf0e10cSrcweir 93cdf0e10cSrcweir //------------------------------------------------------------------------- 94cdf0e10cSrcweir 95cdf0e10cSrcweir /** specifies if a user defined sorting list is used. 96cdf0e10cSrcweir */ 97cdf0e10cSrcweir [property] boolean EnableUserSortList; 98cdf0e10cSrcweir 99cdf0e10cSrcweir //------------------------------------------------------------------------- 100cdf0e10cSrcweir 101cdf0e10cSrcweir /** specifies which user defined sorting list is used. 102cdf0e10cSrcweir 103cdf0e10cSrcweir <p>This property is only used if 104cdf0e10cSrcweir <member>SubTotalDescriptor::EnableUserSortList</member> 105cdf0e10cSrcweir is <TRUE/>.</p> 106cdf0e10cSrcweir */ 107cdf0e10cSrcweir [property] long UserSortListIndex; 108cdf0e10cSrcweir 109cdf0e10cSrcweir //------------------------------------------------------------------------- 110cdf0e10cSrcweir 111cdf0e10cSrcweir /** specifies if cell formats are moved with the contents they belong to. 112cdf0e10cSrcweir */ 113cdf0e10cSrcweir [property] boolean BindFormatsToContent; 114cdf0e10cSrcweir 115cdf0e10cSrcweir //------------------------------------------------------------------------- 116cdf0e10cSrcweir 117cdf0e10cSrcweir /** specifies if the contents of the fields will be sorted to groups 118cdf0e10cSrcweir while performing a subtotal operation. 119cdf0e10cSrcweir */ 120cdf0e10cSrcweir [property] boolean EnableSort; 121cdf0e10cSrcweir 122cdf0e10cSrcweir //------------------------------------------------------------------------- 123cdf0e10cSrcweir 124cdf0e10cSrcweir /** specifies the sorting order if 125cdf0e10cSrcweir <member>SubTotalDescriptor::EnableSort</member> is set to <TRUE/>. 126cdf0e10cSrcweir */ 127cdf0e10cSrcweir [property] boolean SortAscending; 128cdf0e10cSrcweir 129cdf0e10cSrcweir //------------------------------------------------------------------------- 130cdf0e10cSrcweir 131cdf0e10cSrcweir /** returns the maximum number of subtotal fields the descriptor can 132cdf0e10cSrcweir hold. 133cdf0e10cSrcweir 134cdf0e10cSrcweir <p>This read-only property indicates the maximum count of fields the 135cdf0e10cSrcweir current implementation supports.</p> 136cdf0e10cSrcweir */ 137cdf0e10cSrcweir [readonly, property] long MaxFieldCount; 138cdf0e10cSrcweir 139cdf0e10cSrcweir}; 140cdf0e10cSrcweir 141cdf0e10cSrcweir//============================================================================= 142cdf0e10cSrcweir 143cdf0e10cSrcweir}; }; }; }; 144cdf0e10cSrcweir 145cdf0e10cSrcweir#endif 146cdf0e10cSrcweir 147