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_table_TableSortField_idl__ 28#define __com_sun_star_table_TableSortField_idl__ 29 30#ifndef __com_sun_star_lang_Locale_idl__ 31#include <com/sun/star/lang/Locale.idl> 32#endif 33#ifndef __com_sun_star_table_TableSortFieldType_idl__ 34#include <com/sun/star/table/TableSortFieldType.idl> 35#endif 36 37 38//============================================================================= 39 40module com { module sun { module star { module table { 41 42//============================================================================= 43/** describes how to sort a single field (row/column) in a tables 44 sort descriptor. 45 46 @see com::sun::star::table::TableSortDescriptor2 47 48 @since OOo 1.1.2 49 */ 50published struct TableSortField 51{ 52 //------------------------------------------------------------------------- 53 /** index of the row or column in the table to be sorted; 0-based. 54 */ 55 long Field; 56 57 //------------------------------------------------------------------------- 58 /** <TRUE/> if data are sorted in ascending order, 59 <FALSE/> if in descending order. 60 */ 61 boolean IsAscending; 62 63 //------------------------------------------------------------------------- 64 /** specifies if the case of letters is important when comparing entries. 65 */ 66 boolean IsCaseSensitive; 67 68 //------------------------------------------------------------------------- 69 /** type of contents in the field. 70 71 <p>If the value is 72 <member scope="com::sun::star::table::TableSortFieldType">AUTOMATIC</member> 73 the algorithm used for sorting is application specific. 74 Especially it may or may not use the values given by 75 'CollatorLocale' and 'CollatorAlgorithm'.</p> 76 */ 77 com::sun::star::table::TableSortFieldType FieldType; 78 79 //------------------------------------------------------------------------- 80 /** the locale used by the collator when comparing/sorting text. 81 82 <p>This property will not be used when the 'FieldType' is 83 <member scope="com::sun::star::table::TableSortFieldType">NUMERIC</member> 84 </p> 85 86 @ see com::sun::star::i18n::XCollator 87 */ 88 com::sun::star::lang::Locale CollatorLocale; 89 90 //------------------------------------------------------------------------- 91 /** the algorithm used by the collator when comparing/sorting text. 92 93 <p>This property will not be used when the 'FieldType' is 94 <member scope="com::sun::star::table::TableSortFieldType">NUMERIC</member> 95 </p> 96 97 @ see com::sun::star::i18n::XCollator 98 */ 99 string CollatorAlgorithm; 100 101}; 102 103//============================================================================= 104 105}; }; }; }; 106 107#endif 108