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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_SubTotalDescriptor_idl__
  21 #define __com_sun_star_sheet_SubTotalDescriptor_idl__
  22
  23 #include <com/sun/star/sheet/XSubTotalDescriptor.idl>
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25 #include <com/sun/star/container/XEnumerationAccess.idl>
  26 #include <com/sun/star/container/XIndexAccess.idl>
  27
  28
  29 module com {  module sun {  module star {  module sheet {
  30
  31
  32 /** represents a description of how subtotals are created.
  33
  34     <p>The descriptor contains properties and a collection of subtotal fields
  35     which control the behavior of operation.</p>
  36  */
  37 published service SubTotalDescriptor
  38 {
  39
  40     /** provides access to the collection of subtotal fields.
  41      */
  42     interface com::sun::star::sheet::XSubTotalDescriptor;
  43
  44
  45     /** creates an enumeration of all sub total fields.
  46
  47         @see com::sun::star::sheet::SubTotalFieldsEnumeration
  48      */
  49     interface com::sun::star::container::XEnumerationAccess;
  50
  51
  52     /** provides access to the sub total fields in the collection via index.
  53      */
  54     interface com::sun::star::container::XIndexAccess;
  55
  56
  57 //!published service PropertySet
  58     /** provides access to the properties.
  59      */
  60     interface com::sun::star::beans::XPropertySet;
  61
  62
  63     /** specifies if page breaks are inserted after each group change.
  64      */
  65     [property] boolean InsertPageBreaks;
  66
  67
  68     /** specifies if the case of letters is important when comparing entries.
  69      */
  70     [property] boolean IsCaseSensitive;
  71
  72
  73     /** specifies if a user defined sorting list is used.
  74      */
  75     [property] boolean EnableUserSortList;
  76
  77
  78     /** specifies which user defined sorting list is used.
  79
  80         <p>This property is only used if
  81         SubTotalDescriptor::EnableUserSortList
  82         is `TRUE`.</p>
  83      */
  84     [property] long UserSortListIndex;
  85
  86
  87     /** specifies if cell formats are moved with the contents they belong to.
  88      */
  89     [property] boolean BindFormatsToContent;
  90
  91
  92     /** specifies if the contents of the fields will be sorted to groups
  93         while performing a subtotal operation.
  94      */
  95     [property] boolean EnableSort;
  96
  97
  98     /** specifies the sorting order if
  99         SubTotalDescriptor::EnableSort is set to `TRUE`.
 100      */
 101     [property] boolean SortAscending;
 102
 103
 104     /** returns the maximum number of subtotal fields the descriptor can
 105         hold.
 106
 107         <p>This read-only property indicates the maximum count of fields the
 108         current implementation supports.</p>
 109      */
 110     [readonly, property] long MaxFieldCount;
 111
 112 };
 113
 114
 115 }; }; }; };
 116
 117 #endif
 118
 119 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */