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