1 /*************************************************************************
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
5 * Copyright 2008 by Sun Microsystems, Inc.
7 * OpenOffice.org - a multi-platform office productivity suite
9 * $RCSfile: XDataPilotDescriptor.idl,v $
12 * This file is part of OpenOffice.org.
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.
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).
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.
29 ************************************************************************/
31 #ifndef __com_sun_star_sheet_XDataPilotDescriptor_idl__
32 #define __com_sun_star_sheet_XDataPilotDescriptor_idl__
34 #ifndef __com_sun_star_container_XNamed_idl__
35 #include
<com
/sun
/star
/container
/XNamed.idl
>
38 #ifndef __com_sun_star_table_CellRangeAddress_idl__
39 #include
<com
/sun
/star
/table
/CellRangeAddress.idl
>
42 #ifndef __com_sun_star_sheet_XSheetFilterDescriptor_idl__
43 #include
<com
/sun
/star
/sheet
/XSheetFilterDescriptor.idl
>
46 #ifndef __com_sun_star_container_XIndexAccess_idl__
47 #include
<com
/sun
/star
/container
/XIndexAccess.idl
>
50 //=============================================================================
52 module com
{ module sun
{ module star
{ module sheet
{
54 //=============================================================================
56 /** provides access to the layout settings of a data pilot table.
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>
62 @see com::sun::star::sheet::DataPilotDescriptor
63 @see com::sun::star::sheet::DataPilotTable
65 published
interface XDataPilotDescriptor
: com
::sun
::star
::container
::XNamed
67 //-------------------------------------------------------------------------
69 /** returns an additional string stored in the data pilot table.
73 //-------------------------------------------------------------------------
75 /** sets an additional string stored in the data pilot table.
77 void setTag
( [in] string aTag
);
79 //-------------------------------------------------------------------------
81 /** returns the cell range containing the data for the data pilot table.
83 com
::sun
::star
::table
::CellRangeAddress getSourceRange
();
85 //-------------------------------------------------------------------------
87 /** sets the cell range containing the data for the data pilot table.
90 [in] com
::sun
::star
::table
::CellRangeAddress aSourceRange
);
92 //-------------------------------------------------------------------------
94 /** returns the filter descriptor specifying which data from the
95 source cell range are used for the data pilot table.
97 com
::sun
::star
::sheet
::XSheetFilterDescriptor getFilterDescriptor
();
99 //-------------------------------------------------------------------------
101 /** returns the collection of all the data pilot fields.
103 com
::sun
::star
::container
::XIndexAccess getDataPilotFields
();
105 //-------------------------------------------------------------------------
107 /** returns the collection of the data pilot fields used as column fields.
109 @see com::sun::star::sheet::DataPilotFields
111 com
::sun
::star
::container
::XIndexAccess getColumnFields
();
113 //-------------------------------------------------------------------------
115 /** returns the collection of the data pilot fields used as row fields.
117 @see com::sun::star::sheet::DataPilotFields
119 com
::sun
::star
::container
::XIndexAccess getRowFields
();
121 //-------------------------------------------------------------------------
123 /** returns the collection of the data pilot fields used as page fields.
125 @see com::sun::star::sheet::DataPilotFields
127 com
::sun
::star
::container
::XIndexAccess getPageFields
();
129 //-------------------------------------------------------------------------
131 /** returns the collection of the data pilot fields used as data fields.
133 @see com::sun::star::sheet::DataPilotFields
135 com
::sun
::star
::container
::XIndexAccess getDataFields
();
137 //-------------------------------------------------------------------------
139 /** returns the collection of the data pilot fields not used as
140 column, row, page, or data fields.
142 @see com::sun::star::sheet::DataPilotFields
144 com
::sun
::star
::container
::XIndexAccess getHiddenFields
();
148 //=============================================================================