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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /**
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_sheet_DataPilotFieldReference_idl__
  21 #define __com_sun_star_sheet_DataPilotFieldReference_idl__
  22
  23 #include <com/sun/star/sheet/DataPilotFieldReferenceItemType.idl>
  24
  25
  26 module com {  module sun {  module star {  module sheet {
  27
  28
  29 /** controls how a data pilot field's results are shown in relation to
  30     a selected reference result.
  31
  32     @see com::sun::star::sheet::DataPilotField
  33  */
  34 published struct DataPilotFieldReference
  35 {
  36
  37     /** contains the type of the reference.
  38
  39     @see com::sun::star::sheet::DataPilotFieldReferenceType
  40
  41         */
  42
  43         long ReferenceType;
  44
  45
  46     /** contains the reference field
  47         */
  48
  49         string ReferenceField;
  50
  51
  52     /** selects between a named reference item and using the previous or next
  53         item for each item from the reference field.
  54
  55     @see com::sun::star::sheet::DataPilotFieldReferenceItemType
  56
  57         */
  58
  59         long ReferenceItemType;
  60
  61
  62     /** contains the name of the reference item, when the
  63         <member>DataPilotFieldReference::ReferenceItemType</member> is NAMED
  64         otherwise is empty
  65         */
  66
  67         string ReferenceItemName;
  68 };
  69
  70
  71 }; }; }; };
  72
  73 #endif
  74
  75 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */