xref: /aoo41x/main/offapi/com/sun/star/sheet/DataPilotFieldReference.idl (revision d1766043)

/**************************************************************
 *
 * 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_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