1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23#ifndef __com_sun_star_util_SortDescriptor_idl__ 24#define __com_sun_star_util_SortDescriptor_idl__ 25 26#ifndef __com_sun_star_beans_XPropertySet_idl__ 27#include <com/sun/star/beans/XPropertySet.idl> 28#endif 29 30#ifndef __com_sun_star_lang_Locale_idl__ 31#include <com/sun/star/lang/Locale.idl> 32#endif 33 34//============================================================================= 35 36module com { module sun { module star { module util { 37 38//============================================================================= 39 40/** specifies the properties which can be used to describe 41 a sort order applied to an XSortable. 42 43 @see XSortable 44 45 @deprecated 46 */ 47published service SortDescriptor 48{ 49 interface com::sun::star::beans::XPropertySet; 50 51 //------------------------------------------------------------------------- 52 /** specifies if the case of letters is important when comparing entries. 53 */ 54 [property] boolean IsCaseSensitive; 55 56 //------------------------------------------------------------------------- 57 /** specifies the sorting order. 58 59 The sorting order may be defined for sepearte keys in specific 60 implementations. For those this property may not need to be set. 61 62 @see <type scope"com::sun::star::text">TextSortDescriptor</type> 63 */ 64 [optional, property] boolean SortAscending; 65 66 //------------------------------------------------------------------------- 67 /** specifies if the columns are sorted. 68 69 <dl> 70 <dt> 71 <TRUE/> 72 </dt> 73 <dd>The columns are sorted. 74 75 </dd> 76 <dt> 77 <FALSE/> 78 </dt> 79 <dd>The rows are sorted. 80 </dd> 81 </dl> 82 */ 83 [property] boolean SortColumns; 84 85 //------------------------------------------------------------------------- 86 /** specifies the locale for the compare operator (collator). 87 */ 88 [property] com::sun::star::lang::Locale CollatorLocale; 89 90 //------------------------------------------------------------------------- 91 /** specifies the algorithm for the compare operator (collator). 92 93 The collator algorithm may be defined for sepearte keys in specific 94 implementations. For those this property may not need to be set. 95 96 @see <type scope"com::sun::star::text">TextSortDescriptor</type> 97 98 @see com::sun::star::i18n::XCollator 99 */ 100 [optional, property] string CollatorAlgorithm; 101}; 102 103//============================================================================= 104 105}; }; }; }; 106 107#endif 108