diff options
Diffstat (limited to 'offapi/com/sun/star/util/SortDescriptor.idl')
-rw-r--r-- | offapi/com/sun/star/util/SortDescriptor.idl | 111 |
1 files changed, 111 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/SortDescriptor.idl b/offapi/com/sun/star/util/SortDescriptor.idl new file mode 100644 index 000000000000..cab1cf01f0e2 --- /dev/null +++ b/offapi/com/sun/star/util/SortDescriptor.idl @@ -0,0 +1,111 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_util_SortDescriptor_idl__ +#define __com_sun_star_util_SortDescriptor_idl__ + +#ifndef __com_sun_star_beans_XPropertySet_idl__ +#include <com/sun/star/beans/XPropertySet.idl> +#endif + +#ifndef __com_sun_star_lang_Locale_idl__ +#include <com/sun/star/lang/Locale.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module util { + +//============================================================================= + +/** specifies the properties which can be used to describe + a sort order applied to an XSortable. + + @see XSortable + + @deprecated + */ +published service SortDescriptor +{ + interface com::sun::star::beans::XPropertySet; + + //------------------------------------------------------------------------- + /** specifies if the case of letters is important when comparing entries. + */ + [property] boolean IsCaseSensitive; + + //------------------------------------------------------------------------- + /** specifies the sorting order. + + The sorting order may be defined for sepearte keys in specific + implementations. For those this property may not need to be set. + + @see <type scope"com::sun::star::text">TextSortDescriptor</type> + */ + [optional, property] boolean SortAscending; + + //------------------------------------------------------------------------- + /** specifies if the columns are sorted. + + <dl> + <dt> + <TRUE/> + </dt> + <dd>The columns are sorted. + + </dd> + <dt> + <FALSE/> + </dt> + <dd>The rows are sorted. + </dd> + </dl> + */ + [property] boolean SortColumns; + + //------------------------------------------------------------------------- + /** specifies the locale for the compare operator (collator). + */ + [property] com::sun::star::lang::Locale CollatorLocale; + + //------------------------------------------------------------------------- + /** specifies the algorithm for the compare operator (collator). + + The collator algorithm may be defined for sepearte keys in specific + implementations. For those this property may not need to be set. + + @see <type scope"com::sun::star::text">TextSortDescriptor</type> + + @see com::sun::star::i18n::XCollator + */ + [optional, property] string CollatorAlgorithm; +}; + +//============================================================================= + +}; }; }; }; + +#endif |