xref: /AOO41X/main/offapi/com/sun/star/table/TableSortDescriptor.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_table_TableSortDescriptor_idl__
25#define __com_sun_star_table_TableSortDescriptor_idl__
26
27#ifndef __com_sun_star_util_SortDescriptor_idl__
28#include <com/sun/star/util/SortDescriptor.idl>
29#endif
30
31#ifndef __com_sun_star_util_SortField_idl__
32#include <com/sun/star/util/SortField.idl>
33#endif
34
35#ifndef __com_sun_star_table_TableOrientation_idl__
36#include <com/sun/star/table/TableOrientation.idl>
37#endif
38
39//=============================================================================
40
41module com {  module sun {  module star {  module table {
42
43//=============================================================================
44
45/** contains properties which describe sorting of rows or columns in a table.
46
47    <p>It extends the general
48    <type scope="com::sun::star::util">SortDescriptor</type> with
49    table-specific properties.</p>
50
51    @deprecated
52 */
53published service TableSortDescriptor
54{
55    //-------------------------------------------------------------------------
56
57    /** contains common sorting properties.
58     */
59    service com::sun::star::util::SortDescriptor;
60
61    //=========================================================================
62
63    /** specifies the descriptions of the individual sort fields.
64     */
65    [property] sequence<com::sun::star::util::SortField> SortFields;
66
67    //-------------------------------------------------------------------------
68
69    /** contains the maximum number of sort fields the descriptor can hold.
70     */
71    [readonly, property] long MaxFieldCount;
72
73    //-------------------------------------------------------------------------
74
75    /** specifies the sorting orientation (sort rows or columns).
76
77        <p>Some implementations may not support sorting columns.</p>
78
79        @deprecated
80         use the property <member scope="com::sun::star::util">SortDescriptor::SortColumns</member>
81         instead.
82     */
83    [property] com::sun::star::table::TableOrientation Orientation;
84
85    //-------------------------------------------------------------------------
86
87    /** specifies whether the first row or column (depending on
88        <member scope="com::sun::star::util">SortDescriptor::SortColumns</member>) is a
89        header which should not be sorted.
90     */
91    [property] boolean ContainsHeader;
92
93};
94
95//=============================================================================
96
97}; }; }; };
98
99#endif
100
101