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