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
  21 module com {  module sun {  module star {  module sheet {
  22
  23
  24 /** represents a description of how subtotals are created.
  25
  26     <p>The descriptor contains properties and a collection of subtotal fields
  27     which control the behavior of operation.</p>
  28  */
  29 published service SubTotalDescriptor
  30 {
  31
  32     /** provides access to the collection of subtotal fields.
  33      */
  34     interface com::sun::star::sheet::XSubTotalDescriptor;
  35
  36
  37     /** creates an enumeration of all sub total fields.
  38
  39         @see com::sun::star::sheet::SubTotalFieldsEnumeration
  40      */
  41     interface com::sun::star::container::XEnumerationAccess;
  42
  43
  44     /** provides access to the sub total fields in the collection via index.
  45      */
  46     interface com::sun::star::container::XIndexAccess;
  47
  48
  49 //!published service PropertySet
  50     /** provides access to the properties.
  51      */
  52     interface com::sun::star::beans::XPropertySet;
  53
  54
  55     /** specifies if page breaks are inserted after each group change.
  56      */
  57     [property] boolean InsertPageBreaks;
  58
  59
  60     /** specifies if the case of letters is important when comparing entries.
  61      */
  62     [property] boolean IsCaseSensitive;
  63
  64
  65     /** specifies if a user defined sorting list is used.
  66      */
  67     [property] boolean EnableUserSortList;
  68
  69
  70     /** specifies which user defined sorting list is used.
  71
  72         <p>This property is only used if
  73         SubTotalDescriptor::EnableUserSortList
  74         is `TRUE`.</p>
  75      */
  76     [property] long UserSortListIndex;
  77
  78
  79     /** specifies if cell formats are moved with the contents they belong to.
  80      */
  81     [property] boolean BindFormatsToContent;
  82
  83
  84     /** specifies if the contents of the fields will be sorted to groups
  85         while performing a subtotal operation.
  86      */
  87     [property] boolean EnableSort;
  88
  89
  90     /** specifies the sorting order if
  91         SubTotalDescriptor::EnableSort is set to `TRUE`.
  92      */
  93     [property] boolean SortAscending;
  94
  95
  96     /** returns the maximum number of subtotal fields the descriptor can
  97         hold.
  98
  99         <p>This read-only property indicates the maximum count of fields the
 100         current implementation supports.</p>
 101      */
 102     [readonly, property] long MaxFieldCount;
 103
 104 };
 105
 106
 107 }; }; }; };
 108
 109 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */