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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XDataPilotDescriptor.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__
  32 #define __com_sun_star_sheet_XDataPilotDescriptor_idl__
  33
  34 #ifndef __com_sun_star_container_XNamed_idl__
  35 #include <com/sun/star/container/XNamed.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  39 #include <com/sun/star/table/CellRangeAddress.idl>
  40 #endif
  41
  42 #ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
  43 #include <com/sun/star/sheet/XSheetFilterDescriptor.idl>
  44 #endif
  45
  46 #ifndef __com_sun_star_container_XIndexAccess_idl__
  47 #include <com/sun/star/container/XIndexAccess.idl>
  48 #endif
  49
  50 //=============================================================================
  51
  52 module com {  module sun {  module star {  module sheet {
  53
  54 //=============================================================================
  55
  56 /** provides access to the layout settings of a data pilot table.
  57
  58     <p>This interface extends the interface
  59     <type scope="com::sun::star::container">XNamed</type> which provides
  60     access to the name of the data pilot table used e.g. in collections.</p>
  61
  62     @see com::sun::star::sheet::DataPilotDescriptor
  63     @see com::sun::star::sheet::DataPilotTable
  64  */
  65 published interface XDataPilotDescriptor: com::sun::star::container::XNamed
  66 {
  67     //-------------------------------------------------------------------------
  68
  69     /** returns an additional string stored in the data pilot table.
  70      */
  71     string getTag();
  72
  73     //-------------------------------------------------------------------------
  74
  75     /** sets an additional string stored in the data pilot table.
  76      */
  77     void setTag( [in] string aTag );
  78
  79     //-------------------------------------------------------------------------
  80
  81     /** returns the cell range containing the data for the data pilot table.
  82      */
  83     com::sun::star::table::CellRangeAddress getSourceRange();
  84
  85     //-------------------------------------------------------------------------
  86
  87     /** sets the cell range containing the data for the data pilot table.
  88      */
  89     void setSourceRange(
  90             [in] com::sun::star::table::CellRangeAddress aSourceRange );
  91
  92     //-------------------------------------------------------------------------
  93
  94     /** returns the filter descriptor specifying which data from the
  95         source cell range are used for the data pilot table.
  96      */
  97     com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor();
  98
  99     //-------------------------------------------------------------------------
 100
 101     /** returns the collection of all the data pilot fields.
 102      */
 103     com::sun::star::container::XIndexAccess getDataPilotFields();
 104
 105     //-------------------------------------------------------------------------
 106
 107     /** returns the collection of the data pilot fields used as column fields.
 108
 109         @see com::sun::star::sheet::DataPilotFields
 110      */
 111     com::sun::star::container::XIndexAccess getColumnFields();
 112
 113     //-------------------------------------------------------------------------
 114
 115     /** returns the collection of the data pilot fields used as row fields.
 116
 117         @see com::sun::star::sheet::DataPilotFields
 118      */
 119     com::sun::star::container::XIndexAccess getRowFields();
 120
 121     //-------------------------------------------------------------------------
 122
 123     /** returns the collection of the data pilot fields used as page fields.
 124
 125         @see com::sun::star::sheet::DataPilotFields
 126      */
 127     com::sun::star::container::XIndexAccess getPageFields();
 128
 129     //-------------------------------------------------------------------------
 130
 131     /** returns the collection of the data pilot fields used as data fields.
 132
 133         @see com::sun::star::sheet::DataPilotFields
 134      */
 135     com::sun::star::container::XIndexAccess getDataFields();
 136
 137     //-------------------------------------------------------------------------
 138
 139     /** returns the collection of the data pilot fields not used as
 140         column, row, page, or data fields.
 141
 142         @see com::sun::star::sheet::DataPilotFields
 143      */
 144     com::sun::star::container::XIndexAccess getHiddenFields();
 145
 146 };
 147
 148 //=============================================================================
 149
 150 }; }; }; };
 151
 152 #endif
 153