xref: /AOO41X/main/offapi/com/sun/star/sheet/DataPilotFieldSortInfo.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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#ifndef __com_sun_star_sheet_DataPilotFieldSortInfo_idl__
28#define __com_sun_star_sheet_DataPilotFieldSortInfo_idl__
29
30#ifndef __com_sun_star_sheet_DataPilotFieldSortMode_idl__
31#include <com/sun/star/sheet/DataPilotFieldSortMode.idl>
32#endif
33
34//=============================================================================
35
36module com {  module sun {  module star {  module sheet {
37
38//=============================================================================
39/** describes how to sort a single DataPilotField
40 */
41published struct DataPilotFieldSortInfo
42{
43    //-------------------------------------------------------------------------
44
45    /** contains the data field to sort by if the Mode is DATA
46     */
47
48    string Field;
49
50    //-------------------------------------------------------------------------
51
52    /** <TRUE/> if data are sorted in ascending order,
53        <FALSE/> if in descending order.
54     */
55
56    boolean IsAscending;
57
58    //-------------------------------------------------------------------------
59
60    /** contains the sort mode
61
62    @see com::sun::star::sheet::DataPilotFieldSortMode
63
64     */
65
66    long Mode;
67
68};
69
70//=============================================================================
71
72}; }; }; };
73
74#endif
75