/*************************************************************************
 *
 * 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_DataPilotFieldReference_idl__
#define __com_sun_star_sheet_DataPilotFieldReference_idl__

#ifndef __com_sun_star_sheet_DataPilotFieldReferenceItemType_idl__
#include <com/sun/star/sheet/DataPilotFieldReferenceItemType.idl>
#endif

//=============================================================================

module com {  module sun {  module star {  module sheet {

//=============================================================================

/** controls how a data pilot field's results are shown in relation to
    a selected reference result.

    @see com::sun::star::sheet::DataPilotField
 */
published struct DataPilotFieldReference
{
    //-------------------------------------------------------------------------

    /** contains the type of the reference.

    @see com::sun::star::sheet::DataPilotFieldReferenceType

        */

        long ReferenceType;

    //-------------------------------------------------------------------------

    /** contains the reference field
        */

        string ReferenceField;

    //-------------------------------------------------------------------------

    /** selects between a named reference item and using the previous or next
        item for each item from the reference field.

    @see com::sun::star::sheet::DataPilotFieldReferenceItemType

        */

        long ReferenceItemType;

    //-------------------------------------------------------------------------

    /** contains the name of the reference item, when the
        <member>DataPilotFieldReference::ReferenceItemType</member> is NAMED
        otherwise is empty
        */

        string ReferenceItemName;
};

//=============================================================================

}; }; }; };

#endif

