/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: SortDescriptor.idl,v $
 *
 *  $Revision: 1.14 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 08:53:57 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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
