/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: TableSortField.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:50:25 $
 *
 *  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_table_TableSortField_idl__
#define __com_sun_star_table_TableSortField_idl__

#ifndef __com_sun_star_lang_Locale_idl__
#include <com/sun/star/lang/Locale.idl>
#endif
#ifndef __com_sun_star_table_TableSortFieldType_idl__
#include <com/sun/star/table/TableSortFieldType.idl>
#endif


//=============================================================================

module com {  module sun {  module star {  module table {

//=============================================================================
/** describes how to sort a single field (row/column) in a tables
    sort descriptor.

    @see com::sun::star::table::TableSortDescriptor2

    @since OOo 1.1.2
 */
published struct TableSortField
{
    //-------------------------------------------------------------------------
    /** index of the row or column in the table to be sorted; 0-based.
     */
    long Field;

    //-------------------------------------------------------------------------
    /** <TRUE/> if data are sorted in ascending order,
        <FALSE/> if in descending order.
     */
    boolean IsAscending;

    //-------------------------------------------------------------------------
    /** specifies if the case of letters is important when comparing entries.
     */
    boolean IsCaseSensitive;

    //-------------------------------------------------------------------------
    /** type of contents in the field.

        <p>If the value is
        <member scope="com::sun::star::table::TableSortFieldType">AUTOMATIC</member>
        the algorithm used for sorting is application specific.
        Especially it may or may not use the values given by
        'CollatorLocale' and 'CollatorAlgorithm'.</p>
     */
    com::sun::star::table::TableSortFieldType FieldType;

    //-------------------------------------------------------------------------
    /** the locale used by the collator when comparing/sorting text.

        <p>This property will not be used when the 'FieldType' is
        <member scope="com::sun::star::table::TableSortFieldType">NUMERIC</member>
        </p>

        @ see   com::sun::star::i18n::XCollator
     */
    com::sun::star::lang::Locale CollatorLocale;

    //-------------------------------------------------------------------------
    /** the algorithm used by the collator when comparing/sorting text.

        <p>This property will not be used when the 'FieldType' is
        <member scope="com::sun::star::table::TableSortFieldType">NUMERIC</member>
        </p>

        @ see   com::sun::star::i18n::XCollator
     */
    string CollatorAlgorithm;

};

//=============================================================================

}; }; }; };

#endif
