AOO410/main/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl

/**************************************************************
 * 
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 * 
 *   http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the 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 OpenOffice 3.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