offapi/com/sun/star/sheet/DataPilotField.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_DataPilotField_idl__
  21 #define __com_sun_star_sheet_DataPilotField_idl__
  22
  23 #include <com/sun/star/container/XNamed.idl>
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25 #include <com/sun/star/sheet/XDataPilotField.idl>
  26 #include <com/sun/star/sheet/XDataPilotFieldGrouping.idl>
  27 #include <com/sun/star/sheet/DataPilotFieldOrientation.idl>
  28 #include <com/sun/star/sheet/GeneralFunction.idl>
  29 #include <com/sun/star/sheet/DataPilotFieldReference.idl>
  30 #include <com/sun/star/sheet/DataPilotFieldLayoutInfo.idl>
  31 #include <com/sun/star/sheet/DataPilotFieldAutoShowInfo.idl>
  32 #include <com/sun/star/sheet/DataPilotFieldSortInfo.idl>
  33 #include <com/sun/star/sheet/DataPilotFieldGroupInfo.idl>
  34
  35
  36 module com {  module sun {  module star {  module sheet {
  37
  38
  39 /** represents a single field in a data pilot table.
  40
  41     <p>If the data pilot table is based on a spreadsheet cell range, a field
  42     is represented by a column of the range and is named using the topmost
  43     cell of the column.</p>
  44  */
  45 published service DataPilotField
  46 {
  47
  48     /** provides access to the name of the data pilot field.
  49      */
  50     interface com::sun::star::container::XNamed;
  51
  52
  53 //!published service PropertySet
  54     /** provides access to the properties.
  55      */
  56     interface com::sun::star::beans::XPropertySet;
  57
  58
  59     [optional] interface XDataPilotField;
  60
  61
  62     [optional] interface XDataPilotFieldGrouping;
  63
  64
  65     /** specifies the orientation of the field.
  66
  67         <p>If the orientation of a field has been changed using this property,
  68         the field will be moved to the last position in the collection of all
  69         fields with the specified orientation.</p>
  70      */
  71     [property] DataPilotFieldOrientation Orientation;
  72
  73
  74     /** specifies the function used to calculate results for this field.
  75
  76         <p>For column and row fields, this is the function for subtotals
  77         (GeneralFunction::NONE means no subtotals).
  78         For data fields, this is the function shown in the data pilot
  79         table.</p>
  80      */
  81     [property] GeneralFunction Function;
  82
  83
  84     /** specifies the functions used to calculate subtotals for this field.
  85
  86         <p>This property is supported by column and row fields only.</p>
  87
  88         <p>An empty sequence means no subtotals. The same effect can be
  89         achieved by setting the property #Function to the
  90         value GeneralFunction::NONE. If the length of the
  91         sequence is greater then 1, then the sequence MUST NOT contain one of
  92         the values GeneralFunction::NONE or
  93         GeneralFunction::AUTO.</p>
  94
  95         <p>The order of the functions in this sequence is reflected in the
  96         DataPilot table. Multiple entries of the same function are ignored
  97         when setting the property.</p>
  98      */
  99     [property, optional] sequence<GeneralFunction> Subtotals;
 100
 101
 102     /** specifies the selected page which is used to filter the data pilot.
 103      */
 104     [property, optional] string SelectedPage;
 105
 106
 107     /** specifies whether to use the selected page to filter the data pilot or
 108         show all.
 109      */
 110     [property, optional] boolean UseSelectedPage;
 111
 112
 113     /** specifies which hierarchy of the dimension is used.
 114
 115     @see com::sun::star::sheet::DataPilotSourceHierarchies
 116      */
 117     [property, optional] string UsedHierarchy;
 118
 119
 120     /** specifies whether this field has sorting information.
 121      */
 122     [property, optional] boolean HasSortInfo;
 123
 124
 125     /** controls how the field's items are sorted.
 126      */
 127     [property, optional] DataPilotFieldSortInfo SortInfo;
 128
 129
 130     /** specifies whether this field has layout information.
 131      */
 132     [property, optional] boolean HasLayoutInfo;
 133
 134
 135     /** controls how the field's items are laid out in the result table.
 136      */
 137     [property, optional] DataPilotFieldLayoutInfo LayoutInfo;
 138
 139
 140     /** specifies whether this field has auto show information.
 141      */
 142     [property, optional] boolean HasAutoShowInfo;
 143
 144
 145     /** enables the automatic inclusion of only a number of items with
 146         the highest or lowest result values.
 147      */
 148     [property, optional] DataPilotFieldAutoShowInfo AutoShowInfo;
 149
 150
 151     /** specifies whether this field has a reference.
 152      */
 153     [property, optional] boolean HasReference;
 154
 155
 156     /** controls how the results are shown in relation to a selected
 157         reference result.
 158      */
 159     [property, optional] DataPilotFieldReference Reference;
 160
 161
 162     /** specifies whether this field is a group field.
 163      */
 164     [property, optional] boolean IsGroupField;
 165
 166
 167     /** contains the grouping information of the DataPilot field.
 168
 169         <p>By changing the value of this property it is possible to modify the
 170         grouping settings of this field.</p>
 171      */
 172     [property, optional] DataPilotFieldGroupInfo GroupInfo;
 173
 174
 175     /** specifies whether to show this field also if it is empty or not.
 176      */
 177     [property, optional] boolean ShowEmpty;
 178 };
 179
 180
 181 }; }; }; };
 182
 183 #endif
 184
 185 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */