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