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

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