offapi/com/sun/star/sheet/XDataPilotDescriptor.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_XDataPilotDescriptor_idl__
  21 #define __com_sun_star_sheet_XDataPilotDescriptor_idl__
  22
  23 #include <com/sun/star/container/XNamed.idl>
  24 #include <com/sun/star/table/CellRangeAddress.idl>
  25 #include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
  26 #include <com/sun/star/container/XIndexAccess.idl>
  27
  28
  29 module com {  module sun {  module star {  module sheet {
  30
  31
  32 /** provides access to the layout settings of a data pilot table.
  33
  34     <p>This interface extends the interface
  35     com::sun::star::container::XNamed which provides
  36     access to the name of the data pilot table used e.g. in collections.</p>
  37
  38     @see com::sun::star::sheet::DataPilotDescriptor
  39     @see com::sun::star::sheet::DataPilotTable
  40  */
  41 published interface XDataPilotDescriptor: com::sun::star::container::XNamed
  42 {
  43
  44     /** returns an additional string stored in the data pilot table.
  45      */
  46     string getTag();
  47
  48
  49     /** sets an additional string stored in the data pilot table.
  50      */
  51     void setTag( [in] string aTag );
  52
  53
  54     /** returns the cell range containing the data for the data pilot table.
  55      */
  56     com::sun::star::table::CellRangeAddress getSourceRange();
  57
  58
  59     /** sets the cell range containing the data for the data pilot table.
  60      */
  61     void setSourceRange(
  62             [in] com::sun::star::table::CellRangeAddress aSourceRange );
  63
  64
  65     /** returns the filter descriptor specifying which data from the
  66         source cell range are used for the data pilot table.
  67      */
  68     com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor();
  69
  70
  71     /** returns the collection of all the data pilot fields.
  72      */
  73     com::sun::star::container::XIndexAccess getDataPilotFields();
  74
  75
  76     /** returns the collection of the data pilot fields used as column fields.
  77
  78         @see com::sun::star::sheet::DataPilotFields
  79      */
  80     com::sun::star::container::XIndexAccess getColumnFields();
  81
  82
  83     /** returns the collection of the data pilot fields used as row fields.
  84
  85         @see com::sun::star::sheet::DataPilotFields
  86      */
  87     com::sun::star::container::XIndexAccess getRowFields();
  88
  89
  90     /** returns the collection of the data pilot fields used as page fields.
  91
  92         @see com::sun::star::sheet::DataPilotFields
  93      */
  94     com::sun::star::container::XIndexAccess getPageFields();
  95
  96
  97     /** returns the collection of the data pilot fields used as data fields.
  98
  99         @see com::sun::star::sheet::DataPilotFields
 100      */
 101     com::sun::star::container::XIndexAccess getDataFields();
 102
 103
 104     /** returns the collection of the data pilot fields not used as
 105         column, row, page, or data fields.
 106
 107         @see com::sun::star::sheet::DataPilotFields
 108      */
 109     com::sun::star::container::XIndexAccess getHiddenFields();
 110
 111 };
 112
 113
 114 }; }; }; };
 115
 116 #endif
 117
 118 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */