offapi/com/sun/star/table/TableSortDescriptor.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_table_TableSortDescriptor_idl__
  21 #define __com_sun_star_table_TableSortDescriptor_idl__
  22
  23 #include <com/sun/star/util/SortDescriptor.idl>
  24 #include <com/sun/star/util/SortField.idl>
  25 #include <com/sun/star/table/TableOrientation.idl>
  26
  27
  28 module com {  module sun {  module star {  module table {
  29
  30
  31 /** contains properties which describe sorting of rows or columns in a table.
  32
  33     <p>It extends the general
  34     com::sun::star::util::SortDescriptor with
  35     table-specific properties.</p>
  36
  37     @deprecated
  38  */
  39 published service TableSortDescriptor
  40 {
  41
  42     /** contains common sorting properties.
  43      */
  44     service com::sun::star::util::SortDescriptor;
  45
  46
  47     /** specifies the descriptions of the individual sort fields.
  48      */
  49     [property] sequence<com::sun::star::util::SortField> SortFields;
  50
  51
  52     /** contains the maximum number of sort fields the descriptor can hold.
  53      */
  54     [readonly, property] long MaxFieldCount;
  55
  56
  57     /** specifies the sorting orientation (sort rows or columns).
  58
  59         <p>Some implementations may not support sorting columns.</p>
  60
  61         @deprecated
  62          use the property com::sun::star::util::SortDescriptor::SortColumns
  63          instead.
  64      */
  65     [property] com::sun::star::table::TableOrientation Orientation;
  66
  67
  68     /** specifies whether the first row or column (depending on
  69         com::sun::star::util::SortDescriptor::SortColumns) is a
  70         header which should not be sorted.
  71      */
  72     [property] boolean ContainsHeader;
  73
  74 };
  75
  76
  77 }; }; }; };
  78
  79 #endif
  80
  81 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */