diff options
Diffstat (limited to 'offapi/com/sun/star/sheet/DataPilotTablePositionData.idl')
-rw-r--r-- | offapi/com/sun/star/sheet/DataPilotTablePositionData.idl | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl new file mode 100644 index 000000000000..aa97b0dba922 --- /dev/null +++ b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl @@ -0,0 +1,90 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ + +#ifndef __com_sun_star_sheet_DataPilotTablePositionData_idl__ +#define __com_sun_star_sheet_DataPilotTablePositionData_idl__ + +#include <com/sun/star/sheet/DataPilotFieldFilter.idl> + +//============================================================================= + +module com { module sun { module star { module sheet { + +//============================================================================= + +/** This structure contains information on a cell within a DataPilot table. + + <p>This structure contains information on a particular cell within a DataPilot + table, and is used to retrieve its metadata. The <member>PositionType</member> + member specifies in which sub-area of the table the cell is positioned, which + in turn determines the type of metadata contained in the <member>PositionData</member> + member.</p> + + @see com::sun::star::sheet::DataPilotTablePositionType + @see com::sun::star::sheet::DataPiotTableResultData + @see com::sun::star::sheet::DataPiotTableHeaderData + + @since OOo 3.0.0 + */ +struct DataPilotTablePositionData +{ + //------------------------------------------------------------------------- + + /** This parameter specifies which sub-area of a DataPilot table a given + cell is positioned. See <type>DataPilotTablePositionType</type> + for how to interpret the value of this parameter. + + @see com::sun::star::sheet::DataPilotTablePositionType + */ + long PositionType; + + //------------------------------------------------------------------------- + + /** <p>This member contains a structure of different types depending on the + position type specified in <member>PositionType</member> member.</p> + + <p>When the value of <member>PositionType</member> is + <const>DataPilotTablePositionType::RESULT</const>, <member>DataPilotTablePositionData::PositionData</member> + contains an instance of type <type>DataPilotTableResultData</type>, + whereas when the value of <member>DataPilotTablePositionData::PositionType</member> + is either <const>DataPilotTablePositionType::ROW_HEADER</const> + or <const>DataPilotTablePositionType::COLUMN_HEADER</const>, then the + <member>PositionData</member> member contains an instance of type <type> + DataPilotTableHeaderData</type>.</p> + + @see com::sun::star::sheet::DataPiotTableResultData + @see com::sun::star::sheet::DataPiotTableHeaderData + */ + any PositionData; +}; + +//============================================================================= + +}; }; }; }; + +#endif + |