summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/sheet/DataPilotFieldReference.idl
blob: cb7a705665f814d05062a07eb15775464e2b6cde (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef __com_sun_star_sheet_DataPilotFieldReference_idl__
#define __com_sun_star_sheet_DataPilotFieldReference_idl__

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

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

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

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */