offapi/com/sun/star/sheet/DataPilotFieldReference.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_sheet_DataPilotFieldReference_idl__
  29 #define __com_sun_star_sheet_DataPilotFieldReference_idl__
  30
  31 #ifndef __com_sun_star_sheet_DataPilotFieldReferenceItemType_idl__
  32 #include <com/sun/star/sheet/DataPilotFieldReferenceItemType.idl>
  33 #endif
  34
  35 //=============================================================================
  36
  37 module com {  module sun {  module star {  module sheet {
  38
  39 //=============================================================================
  40
  41 /** controls how a data pilot field's results are shown in relation to
  42     a selected reference result.
  43
  44     @see com::sun::star::sheet::DataPilotField
  45  */
  46 published struct DataPilotFieldReference
  47 {
  48     //-------------------------------------------------------------------------
  49
  50     /** contains the type of the reference.
  51
  52     @see com::sun::star::sheet::DataPilotFieldReferenceType
  53
  54         */
  55
  56         long ReferenceType;
  57
  58     //-------------------------------------------------------------------------
  59
  60     /** contains the reference field
  61         */
  62
  63         string ReferenceField;
  64
  65     //-------------------------------------------------------------------------
  66
  67     /** selects between a named reference item and using the previous or next
  68         item for each item from the reference field.
  69
  70     @see com::sun::star::sheet::DataPilotFieldReferenceItemType
  71
  72         */
  73
  74         long ReferenceItemType;
  75
  76     //-------------------------------------------------------------------------
  77
  78     /** contains the name of the reference item, when the
  79         <member>DataPilotFieldReference::ReferenceItemType</member> is NAMED
  80         otherwise is empty
  81         */
  82
  83         string ReferenceItemName;
  84 };
  85
  86 //=============================================================================
  87
  88 }; }; }; };
  89
  90 #endif
  91