offapi/com/sun/star/util/SortDescriptor.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 #ifndef __com_sun_star_util_SortDescriptor_idl__
  20 #define __com_sun_star_util_SortDescriptor_idl__
  21
  22 #include <com/sun/star/beans/XPropertySet.idl>
  23
  24 #include <com/sun/star/lang/Locale.idl>
  25
  26
  27 module com {  module sun {  module star {  module util {
  28
  29
  30 /** specifies the properties which can be used to describe
  31     a sort order applied to an XSortable.
  32
  33     @see XSortable
  34
  35     @deprecated
  36  */
  37 published service SortDescriptor
  38 {
  39      interface com::sun::star::beans::XPropertySet;
  40
  41     /** specifies if the case of letters is important when comparing entries.
  42      */
  43         [property] boolean IsCaseSensitive;
  44
  45     /** specifies the sorting order.
  46
  47         The sorting order may be defined for separate keys in specific
  48         implementations. For those this property may not need to be set.
  49
  50         @see com::sun::star::text::TextSortDescriptor
  51      */
  52         [optional, property] boolean SortAscending;
  53
  54     /** specifies if the columns are sorted.
  55
  56         <dl>
  57         <dt>
  58         `TRUE`
  59         </dt>
  60         <dd>The columns are sorted.
  61
  62         </dd>
  63         <dt>
  64         `FALSE`
  65         </dt>
  66         <dd>The rows are sorted.
  67         </dd>
  68         </dl>
  69      */
  70     [property] boolean SortColumns;
  71
  72     /** specifies the locale for the compare operator (collator).
  73      */
  74     [property] com::sun::star::lang::Locale CollatorLocale;
  75
  76     /** specifies the algorithm for the compare operator (collator).
  77
  78         The collator algorithm may be defined for separate keys in specific
  79         implementations. For those this property may not need to be set.
  80
  81         @see com::sun::star::text::TextSortDescriptor
  82
  83         @see com::sun::star::i18n::XCollator
  84      */
  85         [optional, property] string CollatorAlgorithm;
  86 };
  87
  88
  89 }; }; }; };
  90
  91 #endif
  92
  93 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */