offapi/com/sun/star/sheet/DataPilotDescriptor.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 the description of the layout of a data pilot table.
  25
  26     @see com::sun::star::sheet::DataPilotTable
  27 */
  28 published service DataPilotDescriptor
  29 {
  30
  31     /** provides access to the layout settings of the data pilot table.
  32      */
  33     interface XDataPilotDescriptor;
  34
  35
  36     /** provides access to the layout settings of the data pilot table.
  37      */
  38     [optional] interface com::sun::star::beans::XPropertySet;
  39
  40
  41     /** Provides access to the DataPilotField used to layout
  42         multiple data fields.
  43      */
  44     [optional] interface XDataPilotDataLayoutFieldSupplier;
  45
  46
  47     /** specifies parameters to create the data pilot table from a database.
  48
  49     @see DatabaseImportDescriptor
  50     @since OOo 3.3
  51
  52      */
  53     [optional, property] sequence< com::sun::star::beans::PropertyValue > ImportDescriptor;
  54
  55
  56     /** specifies the name of a DataPilotSource implementation
  57         for the data pilot table.
  58
  59     @since OOo 3.3
  60
  61      */
  62     [optional, property] string SourceServiceName;
  63
  64
  65     /** specifies arguments that are passed to the implementation named by
  66         #SourceServiceName.
  67
  68     @since OOo 3.3
  69
  70      */
  71     [optional, property] sequence< com::sun::star::beans::PropertyValue > ServiceArguments;
  72
  73
  74     /** specifies if empty rows in the source data are ignored.
  75      */
  76     [optional, property] boolean IgnoreEmptyRows;
  77
  78
  79     /** specifies if empty category cells in the source data should be treated
  80         as repetition of the content from the previous row.
  81      */
  82     [optional, property] boolean RepeatIfEmpty;
  83
  84
  85     /** specifies if columns for grand total results are created.
  86      */
  87     [optional, property] boolean ColumnGrand;
  88
  89
  90     /** specifies if rows for grand total results are created.
  91      */
  92     [optional, property] boolean RowGrand;
  93
  94
  95     /** specifies whether the filter button is shown.
  96      */
  97     [optional, property] boolean ShowFilterButton;
  98
  99
 100     /** specifies whether to drill down to details or go into edit mode.
 101      */
 102     [optional, property] boolean DrillDownOnDoubleClick;
 103
 104
 105     /** specifies a label for grand total results.
 106
 107     @since OOo 3.4
 108      */
 109     [optional, property] string GrandTotalName;
 110
 111 };
 112
 113
 114 }; }; }; };
 115
 116 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */