1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__ 25cdf0e10cSrcweir#define __com_sun_star_sheet_XDataPilotDescriptor_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_container_XNamed_idl__ 28cdf0e10cSrcweir#include <com/sun/star/container/XNamed.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir#ifndef __com_sun_star_table_CellRangeAddress_idl__ 32cdf0e10cSrcweir#include <com/sun/star/table/CellRangeAddress.idl> 33cdf0e10cSrcweir#endif 34cdf0e10cSrcweir 35cdf0e10cSrcweir#ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__ 36cdf0e10cSrcweir#include <com/sun/star/sheet/XSheetFilterDescriptor.idl> 37cdf0e10cSrcweir#endif 38cdf0e10cSrcweir 39cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexAccess_idl__ 40cdf0e10cSrcweir#include <com/sun/star/container/XIndexAccess.idl> 41cdf0e10cSrcweir#endif 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweirmodule com { module sun { module star { module sheet { 46cdf0e10cSrcweir 47cdf0e10cSrcweir//============================================================================= 48cdf0e10cSrcweir 49cdf0e10cSrcweir/** provides access to the layout settings of a data pilot table. 50cdf0e10cSrcweir 51cdf0e10cSrcweir <p>This interface extends the interface 52cdf0e10cSrcweir <type scope="com::sun::star::container">XNamed</type> which provides 53cdf0e10cSrcweir access to the name of the data pilot table used e.g. in collections.</p> 54cdf0e10cSrcweir 55cdf0e10cSrcweir @see com::sun::star::sheet::DataPilotDescriptor 56cdf0e10cSrcweir @see com::sun::star::sheet::DataPilotTable 57cdf0e10cSrcweir */ 58cdf0e10cSrcweirpublished interface XDataPilotDescriptor: com::sun::star::container::XNamed 59cdf0e10cSrcweir{ 60cdf0e10cSrcweir //------------------------------------------------------------------------- 61cdf0e10cSrcweir 62cdf0e10cSrcweir /** returns an additional string stored in the data pilot table. 63cdf0e10cSrcweir */ 64cdf0e10cSrcweir string getTag(); 65cdf0e10cSrcweir 66cdf0e10cSrcweir //------------------------------------------------------------------------- 67cdf0e10cSrcweir 68cdf0e10cSrcweir /** sets an additional string stored in the data pilot table. 69cdf0e10cSrcweir */ 70cdf0e10cSrcweir void setTag( [in] string aTag ); 71cdf0e10cSrcweir 72cdf0e10cSrcweir //------------------------------------------------------------------------- 73cdf0e10cSrcweir 74cdf0e10cSrcweir /** returns the cell range containing the data for the data pilot table. 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir com::sun::star::table::CellRangeAddress getSourceRange(); 77cdf0e10cSrcweir 78cdf0e10cSrcweir //------------------------------------------------------------------------- 79cdf0e10cSrcweir 80cdf0e10cSrcweir /** sets the cell range containing the data for the data pilot table. 81cdf0e10cSrcweir */ 82cdf0e10cSrcweir void setSourceRange( 83cdf0e10cSrcweir [in] com::sun::star::table::CellRangeAddress aSourceRange ); 84cdf0e10cSrcweir 85cdf0e10cSrcweir //------------------------------------------------------------------------- 86cdf0e10cSrcweir 87cdf0e10cSrcweir /** returns the filter descriptor specifying which data from the 88cdf0e10cSrcweir source cell range are used for the data pilot table. 89cdf0e10cSrcweir */ 90cdf0e10cSrcweir com::sun::star::sheet::XSheetFilterDescriptor getFilterDescriptor(); 91cdf0e10cSrcweir 92cdf0e10cSrcweir //------------------------------------------------------------------------- 93cdf0e10cSrcweir 94cdf0e10cSrcweir /** returns the collection of all the data pilot fields. 95cdf0e10cSrcweir */ 96cdf0e10cSrcweir com::sun::star::container::XIndexAccess getDataPilotFields(); 97cdf0e10cSrcweir 98cdf0e10cSrcweir //------------------------------------------------------------------------- 99cdf0e10cSrcweir 100cdf0e10cSrcweir /** returns the collection of the data pilot fields used as column fields. 101cdf0e10cSrcweir 102cdf0e10cSrcweir @see com::sun::star::sheet::DataPilotFields 103cdf0e10cSrcweir */ 104cdf0e10cSrcweir com::sun::star::container::XIndexAccess getColumnFields(); 105cdf0e10cSrcweir 106cdf0e10cSrcweir //------------------------------------------------------------------------- 107cdf0e10cSrcweir 108cdf0e10cSrcweir /** returns the collection of the data pilot fields used as row fields. 109cdf0e10cSrcweir 110cdf0e10cSrcweir @see com::sun::star::sheet::DataPilotFields 111cdf0e10cSrcweir */ 112cdf0e10cSrcweir com::sun::star::container::XIndexAccess getRowFields(); 113cdf0e10cSrcweir 114cdf0e10cSrcweir //------------------------------------------------------------------------- 115cdf0e10cSrcweir 116cdf0e10cSrcweir /** returns the collection of the data pilot fields used as page fields. 117cdf0e10cSrcweir 118cdf0e10cSrcweir @see com::sun::star::sheet::DataPilotFields 119cdf0e10cSrcweir */ 120cdf0e10cSrcweir com::sun::star::container::XIndexAccess getPageFields(); 121cdf0e10cSrcweir 122cdf0e10cSrcweir //------------------------------------------------------------------------- 123cdf0e10cSrcweir 124cdf0e10cSrcweir /** returns the collection of the data pilot fields used as data fields. 125cdf0e10cSrcweir 126cdf0e10cSrcweir @see com::sun::star::sheet::DataPilotFields 127cdf0e10cSrcweir */ 128cdf0e10cSrcweir com::sun::star::container::XIndexAccess getDataFields(); 129cdf0e10cSrcweir 130cdf0e10cSrcweir //------------------------------------------------------------------------- 131cdf0e10cSrcweir 132cdf0e10cSrcweir /** returns the collection of the data pilot fields not used as 133cdf0e10cSrcweir column, row, page, or data fields. 134cdf0e10cSrcweir 135cdf0e10cSrcweir @see com::sun::star::sheet::DataPilotFields 136cdf0e10cSrcweir */ 137cdf0e10cSrcweir com::sun::star::container::XIndexAccess getHiddenFields(); 138cdf0e10cSrcweir 139cdf0e10cSrcweir}; 140cdf0e10cSrcweir 141cdf0e10cSrcweir//============================================================================= 142cdf0e10cSrcweir 143cdf0e10cSrcweir}; }; }; }; 144cdf0e10cSrcweir 145cdf0e10cSrcweir#endif 146cdf0e10cSrcweir 147