offapi/com/sun/star/util/SortDescriptor.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_util_SortDescriptor_idl__
  28 #define __com_sun_star_util_SortDescriptor_idl__
  29
  30 #ifndef __com_sun_star_beans_XPropertySet_idl__
  31 #include <com/sun/star/beans/XPropertySet.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_lang_Locale_idl__
  35 #include <com/sun/star/lang/Locale.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com {  module sun {  module star {  module util {
  41
  42 //=============================================================================
  43
  44 /** specifies the properties which can be used to describe
  45     a sort order applied to an XSortable.
  46
  47     @see XSortable
  48
  49     @deprecated
  50  */
  51 published service SortDescriptor
  52 {
  53      interface com::sun::star::beans::XPropertySet;
  54
  55     //-------------------------------------------------------------------------
  56     /** specifies if the case of letters is important when comparing entries.
  57      */
  58         [property] boolean IsCaseSensitive;
  59
  60      //-------------------------------------------------------------------------
  61     /** specifies the sorting order.
  62
  63             The sorting order may be defined for sepearte keys in specific
  64             implementations. For those this property may not need to be set.
  65
  66             @see <type scope"com::sun::star::text">TextSortDescriptor</type>
  67      */
  68         [optional, property] boolean SortAscending;
  69
  70      //-------------------------------------------------------------------------
  71     /** specifies if the columns are sorted.
  72
  73         <dl>
  74         <dt>
  75         <TRUE/>
  76         </dt>
  77         <dd>The columns are sorted.
  78
  79         </dd>
  80         <dt>
  81         <FALSE/>
  82         </dt>
  83         <dd>The rows are sorted.
  84         </dd>
  85         </dl>
  86      */
  87     [property] boolean SortColumns;
  88
  89      //-------------------------------------------------------------------------
  90     /** specifies the locale for the compare operator (collator).
  91      */
  92     [property] com::sun::star::lang::Locale CollatorLocale;
  93
  94      //-------------------------------------------------------------------------
  95     /** specifies the algorithm for the compare operator (collator).
  96
  97             The collator algorithm may be defined for sepearte keys in specific
  98             implementations. For those this property may not need to be set.
  99
 100             @see <type scope"com::sun::star::text">TextSortDescriptor</type>
 101
 102             @see com::sun::star::i18n::XCollator
 103      */
 104         [optional, property] string CollatorAlgorithm;
 105 };
 106
 107 //=============================================================================
 108
 109 }; }; }; };
 110
 111 #endif