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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_DataPilotField_idl__
  29 #define __com_sun_star_sheet_DataPilotField_idl__
  30
  31 #ifndef __com_sun_star_container_XNamed_idl__
  32 #include <com/sun/star/container/XNamed.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_beans_XPropertySet_idl__
  36 #include <com/sun/star/beans/XPropertySet.idl>
  37 #endif
  38
  39 #ifndef __com_sun_star_sheet_XDataPilotField_idl__
  40 #include <com/sun/star/sheet/XDataPilotField.idl>
  41 #endif
  42
  43 #ifndef __com_sun_star_sheet_XDataPilotFieldGrouping_idl__
  44 #include <com/sun/star/sheet/XDataPilotFieldGrouping.idl>
  45 #endif
  46
  47 #ifndef __com_sun_star_sheet_DataPilotFieldOrientation_idl__
  48 #include <com/sun/star/sheet/DataPilotFieldOrientation.idl>
  49 #endif
  50
  51 #ifndef __com_sun_star_sheet_GeneralFunction_idl__
  52 #include <com/sun/star/sheet/GeneralFunction.idl>
  53 #endif
  54
  55 #ifndef __com_sun_star_sheet_DataPilotFieldReference_idl__
  56 #include <com/sun/star/sheet/DataPilotFieldReference.idl>
  57 #endif
  58
  59 #ifndef __com_sun_star_sheet_DataPilotFieldLayoutInfo_idl__
  60 #include <com/sun/star/sheet/DataPilotFieldLayoutInfo.idl>
  61 #endif
  62
  63 #ifndef __com_sun_star_sheet_DataPilotFieldAutoShowInfo_idl__
  64 #include <com/sun/star/sheet/DataPilotFieldAutoShowInfo.idl>
  65 #endif
  66
  67 #ifndef __com_sun_star_sheet_DataPilotFieldSortInfo_idl__
  68 #include <com/sun/star/sheet/DataPilotFieldSortInfo.idl>
  69 #endif
  70
  71 #ifndef __com_sun_star_sheet_DataPilotFieldGroupInfo_idl__
  72 #include <com/sun/star/sheet/DataPilotFieldGroupInfo.idl>
  73 #endif
  74
  75 //=============================================================================
  76
  77 module com {  module sun {  module star {  module sheet {
  78
  79 //=============================================================================
  80
  81 /** represents a single field in a data pilot table.
  82
  83     <p>If the data pilot table is based on a spreadsheet cell range, a field
  84     is representred by a column of the range and is named using the topmost
  85     cell of the column.</p>
  86  */
  87 published service DataPilotField
  88 {
  89     //-------------------------------------------------------------------------
  90
  91     /** provides access to the name of the data pilot field.
  92      */
  93     interface com::sun::star::container::XNamed;
  94
  95     //-------------------------------------------------------------------------
  96
  97 //!published service PropertySet
  98     /** provides access to the properties.
  99      */
 100     interface com::sun::star::beans::XPropertySet;
 101
 102     //-------------------------------------------------------------------------
 103
 104     [optional] interface XDataPilotField;
 105
 106     //-------------------------------------------------------------------------
 107
 108     [optional] interface XDataPilotFieldGrouping;
 109
 110     //=========================================================================
 111
 112     /** specifies the orientation of the field.
 113
 114         <p>If the orientation of a field has been changed using this property,
 115         the field will be moved to the last position in the collection of all
 116         fields with the specified orientation.</p>
 117      */
 118     [property] DataPilotFieldOrientation Orientation;
 119
 120     //-------------------------------------------------------------------------
 121
 122     /** specifies the function used to calculate results for this field.
 123
 124         <p>For column and row fields, this is the function for subtotals
 125         (<const>GeneralFunction::NONE</const> means no subtotals).
 126         For data fields, this is the function shown in the data pilot
 127         table.</p>
 128      */
 129     [property] GeneralFunction Function;
 130
 131     //-------------------------------------------------------------------------
 132
 133     /** specifies the functions used to calculate subtotals for this field.
 134
 135         <p>This property is supported by column and row fields only.</p>
 136
 137         <p>An empty sequence means no subtotals. The same effect can be
 138         achieved by setting the property <member>Function</member> to the
 139         value <const>GeneralFunction::NONE</const>. If the length of the
 140         sequence is greater then 1, then the sequence MUST NOT contain one of
 141         the values <const>GeneralFunction::NONE</const> or
 142         <const>GeneralFunction::AUTO</const>.</p>
 143
 144         <p>The order of the functions in this sequence is reflected in the
 145         DataPilot table. Multiple entries of the same function are ignored
 146         when setting the property.</p>
 147      */
 148     [property, optional] sequence<GeneralFunction> Subtotals;
 149
 150     //-------------------------------------------------------------------------
 151
 152     /** specifies the selected page which is used to filter the data pilot.
 153      */
 154     [property, optional] string SelectedPage;
 155
 156     //-------------------------------------------------------------------------
 157
 158     /** specifies whether to use the selected page to filter the data pilot or
 159         show all.
 160      */
 161     [property, optional] boolean UseSelectedPage;
 162
 163     //-------------------------------------------------------------------------
 164
 165     /** specifies which hierarchy of the dimension is used.
 166
 167     @see com::sun::star::sheet::DataPilotSourceHierarchies
 168      */
 169     [property, optional] string UsedHierarchy;
 170
 171     //-------------------------------------------------------------------------
 172
 173     /** specifies whether this field has sorting information.
 174      */
 175     [property, optional] boolean HasSortInfo;
 176
 177     //-------------------------------------------------------------------------
 178
 179     /** controls how the field's items are sorted.
 180      */
 181     [property, optional] DataPilotFieldSortInfo SortInfo;
 182
 183     //-------------------------------------------------------------------------
 184
 185     /** specifies whether this field has layout information.
 186      */
 187     [property, optional] boolean HasLayoutInfo;
 188
 189     //-------------------------------------------------------------------------
 190
 191     /** controls how the field's items are laid out in the result table.
 192      */
 193     [property, optional] DataPilotFieldLayoutInfo LayoutInfo;
 194
 195     //-------------------------------------------------------------------------
 196
 197     /** specifies whether this field has auto show information.
 198      */
 199     [property, optional] boolean HasAutoShowInfo;
 200
 201     //-------------------------------------------------------------------------
 202
 203     /** enables the automatic inclusion of only a number of items with
 204         the highest or lowest result values.
 205      */
 206     [property, optional] DataPilotFieldAutoShowInfo AutoShowInfo;
 207
 208     //-------------------------------------------------------------------------
 209
 210     /** specifies whether this field has a reference.
 211      */
 212     [property, optional] boolean HasReference;
 213
 214     //-------------------------------------------------------------------------
 215
 216     /** controls how the results are shown in relation to a selected
 217         reference result.
 218      */
 219     [property, optional] DataPilotFieldReference Reference;
 220
 221     //-------------------------------------------------------------------------
 222
 223     /** specifies whether this field is a group field.
 224      */
 225     [property, optional] boolean IsGroupField;
 226
 227     //-------------------------------------------------------------------------
 228
 229     /** contains the grouping information of the DataPilot field.
 230
 231         <p>By changing the value of this property it is possible to modify the
 232         grouping settings of this field.</p>
 233      */
 234     [property, optional] DataPilotFieldGroupInfo GroupInfo;
 235
 236     //-------------------------------------------------------------------------
 237
 238     /** specifies whether to show this field also if it is empty or not.
 239      */
 240     [property, optional] boolean ShowEmpty;
 241 };
 242
 243 //=============================================================================
 244
 245 }; }; }; };
 246
 247 #endif
 248