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