offapi/com/sun/star/table/TableSortDescriptor2.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_TableSortDescriptor2_idl__
  21 #define __com_sun_star_table_TableSortDescriptor2_idl__
  22
  23 #include <com/sun/star/util/SortDescriptor2.idl>
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25 #include <com/sun/star/table/TableSortField.idl>
  26
  27
  28 module com {  module sun {  module star {  module table {
  29
  30
  31 /** specifies properties which describe sorting of fields (rows or columns)
  32     in a table.
  33
  34     @since OOo 1.1.2
  35  */
  36 published service TableSortDescriptor2
  37 {
  38     service com::sun::star::util::SortDescriptor2;
  39
  40     /** specifies a list of individual sort fields.
  41
  42         <p>Each entry specifies properties that state the
  43         row/column to be sorted and how that should be done.</p>
  44      */
  45     [property] sequence< com::sun::star::table::TableSortField > SortFields;
  46
  47     /** contains the maximum number of sort fields the descriptor can hold.
  48      */
  49     [readonly, property] long MaxSortFieldsCount;
  50
  51     /** specifies if the columns or rows are to be sorted.
  52
  53         <dl>
  54             <dt>`TRUE`</dt>
  55             <dd>The columns are to be sorted.</dd>
  56             <dt>`FALSE`</dt>
  57             <dd>The rows are to be sorted.</dd>
  58         </dl>
  59      */
  60     [property] boolean IsSortColumns;
  61 };
  62
  63
  64 }; }; }; };
  65
  66 #endif
  67
  68 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */