summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/table/TableSortDescriptor.idl
blob: f7ef6f69d0cad310da3fd4da5ca4b61403b8e6c7 (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
/* -*- 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_table_TableSortDescriptor_idl__
#define __com_sun_star_table_TableSortDescriptor_idl__

#include <com/sun/star/util/SortDescriptor.idl>
#include <com/sun/star/util/SortField.idl>
#include <com/sun/star/table/TableOrientation.idl>


module com {  module sun {  module star {  module table {


/** contains properties which describe sorting of rows or columns in a table.

    <p>It extends the general
    com::sun::star::util::SortDescriptor with
    table-specific properties.</p>

    @deprecated
 */
published service TableSortDescriptor
{

    /** contains common sorting properties.
     */
    service com::sun::star::util::SortDescriptor;


    /** specifies the descriptions of the individual sort fields.
     */
    [property] sequence<com::sun::star::util::SortField> SortFields;


    /** contains the maximum number of sort fields the descriptor can hold.
     */
    [readonly, property] long MaxFieldCount;


    /** specifies the sorting orientation (sort rows or columns).

        <p>Some implementations may not support sorting columns.</p>

        @deprecated
         use the property com::sun::star::util::SortDescriptor::SortColumns
         instead.
     */
    [property] com::sun::star::table::TableOrientation Orientation;


    /** specifies whether the first row or column (depending on
        com::sun::star::util::SortDescriptor::SortColumns) is a
        header which should not be sorted.
     */
    [property] boolean ContainsHeader;

};


}; }; }; };

#endif

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