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

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