offapi/com/sun/star/sheet/SubTotalDescriptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: SubTotalDescriptor.idl,v $
  10  * $Revision: 1.8 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_SubTotalDescriptor_idl__
  32 #define __com_sun_star_sheet_SubTotalDescriptor_idl__
  33
  34 #ifndef __com_sun_star_sheet_XSubTotalDescriptor_idl__
  35 #include <com/sun/star/sheet/XSubTotalDescriptor.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_XPropertySet_idl__
  39 #include <com/sun/star/beans/XPropertySet.idl>
  40 #endif
  41 #ifndef __com_sun_star_container_XEnumerationAccess_idl__
  42 #include <com/sun/star/container/XEnumerationAccess.idl>
  43 #endif
  44 #ifndef __com_sun_star_container_XIndexAccess_idl__
  45 #include <com/sun/star/container/XIndexAccess.idl>
  46 #endif
  47
  48 //=============================================================================
  49
  50 module com {  module sun {  module star {  module sheet {
  51
  52 //=============================================================================
  53
  54 /** represents a description of how subtotals are created.
  55
  56     <p>The descriptor contains properties and a collection of subtotal fields
  57     which control the behaviour of operation.</p>
  58  */
  59 published service SubTotalDescriptor
  60 {
  61     //-------------------------------------------------------------------------
  62
  63     /** provides access to the collection of subtotal fields.
  64      */
  65     interface com::sun::star::sheet::XSubTotalDescriptor;
  66
  67     //-------------------------------------------------------------------------
  68
  69     /** creates an enumeration of all sub total fields.
  70
  71         @see com::sun::star::sheet::SubTotalFieldsEnumeration
  72      */
  73     interface com::sun::star::container::XEnumerationAccess;
  74
  75     //-------------------------------------------------------------------------
  76
  77     /** provides access to the sub total fields in the collection via index.
  78      */
  79     interface com::sun::star::container::XIndexAccess;
  80
  81     //-------------------------------------------------------------------------
  82
  83 //!published service PropertySet
  84     /** procides access to the properties.
  85      */
  86     interface com::sun::star::beans::XPropertySet;
  87
  88     //=========================================================================
  89
  90     /** specifies if page breaks are inserted after each group change.
  91      */
  92     [property] boolean InsertPageBreaks;
  93
  94     //-------------------------------------------------------------------------
  95
  96     /** specifies if the case of letters is important when comparing entries.
  97      */
  98     [property] boolean IsCaseSensitive;
  99
 100     //-------------------------------------------------------------------------
 101
 102     /** specifies if a user defined sorting list is used.
 103      */
 104     [property] boolean EnableUserSortList;
 105
 106     //-------------------------------------------------------------------------
 107
 108     /** specifies which user defined sorting list is used.
 109
 110         <p>This property is only used if
 111         <member>SubTotalDescriptor::EnableUserSortList</member>
 112         is <TRUE/>.</p>
 113      */
 114     [property] long UserSortListIndex;
 115
 116     //-------------------------------------------------------------------------
 117
 118     /** specifies if cell formats are moved with the contents they belong to.
 119      */
 120     [property] boolean BindFormatsToContent;
 121
 122     //-------------------------------------------------------------------------
 123
 124     /** specifies if the contents of the fields will be sorted to groups
 125         while performing a subtotal operation.
 126      */
 127     [property] boolean EnableSort;
 128
 129     //-------------------------------------------------------------------------
 130
 131     /** specifies the sorting order if
 132         <member>SubTotalDescriptor::EnableSort</member> is set to <TRUE/>.
 133      */
 134     [property] boolean SortAscending;
 135
 136     //-------------------------------------------------------------------------
 137
 138     /** returns the maximum number of subtotal fields the descriptor can
 139         hold.
 140
 141         <p>This read-only property indicates the maximum count of fields the
 142         current implementation supports.</p>
 143      */
 144     [readonly, property] long MaxFieldCount;
 145
 146 };
 147
 148 //=============================================================================
 149
 150 }; }; }; };
 151
 152 #endif
 153