/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: TableSortDescriptor2.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 05:50:12 $
 *
 *  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_TableSortDescriptor2_idl__
#define __com_sun_star_table_TableSortDescriptor2_idl__

#ifndef __com_sun_star_util_SortDescriptor2_idl__
#include <com/sun/star/util/SortDescriptor2.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
#ifndef __com_sun_star_table_TableSortField_idl__
#include <com/sun/star/table/TableSortField.idl>
#endif

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

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

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

/** specifies properties which describe sorting of fields (rows or columns)
    in a table.

    @since OOo 1.1.2
 */
published service TableSortDescriptor2
{
    service com::sun::star::util::SortDescriptor2;

    //-------------------------------------------------------------------------
    /** specifies a list of individual sort fields.

        <p>Each entry specifies properties that state the
        row/column to be sorted and how that should be done.</p>
     */
    [property] sequence< com::sun::star::table::TableSortField > SortFields;

    //-------------------------------------------------------------------------
    /** contains the maximum number of sort fields the descriptor can hold.
     */
    [readonly, property] long MaxSortFieldsCount;

    //-------------------------------------------------------------------------
    /** specifies if the columns or rows are to be sorted.

        <dl>
            <dt><TRUE/></dt>
            <dd>The columns are to be sorted.</dd>
            <dt><FALSE/></dt>
            <dd>The rows are to be sorted.</dd>
        </dl>
     */
    [property] boolean IsSortColumns;
};

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

}; }; }; };

#endif

