/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: SheetSortDescriptor.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 04:51:32 $
 *
 *  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_sheet_SheetSortDescriptor_idl__
#define __com_sun_star_sheet_SheetSortDescriptor_idl__

#ifndef __com_sun_star_table_TableSortDescriptor_idl__
#include <com/sun/star/table/TableSortDescriptor.idl>
#endif

#ifndef __com_sun_star_table_CellAddress_idl__
#include <com/sun/star/table/CellAddress.idl>
#endif

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

module com {  module sun {  module star {  module sheet {

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

/** a description of how a cell range is to be sorted.

	<p>This service extends the <type scope="com::sun::star::table">TableSortDescriptor</type>
	service with spreadsheet specific properties.</p>
 */
published service SheetSortDescriptor
{
	//-------------------------------------------------------------------------

	/** provides common table sorting properties.
	 */
	service com::sun::star::table::TableSortDescriptor;

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

	/** specifies if cell formats are moved with the contents
		they belong to.
	 */
	[property] boolean BindFormatsToContent;

	//-------------------------------------------------------------------------

	/** specifies if a user defined sorting list is used.
	 */
	[property] boolean IsUserListEnabled;

	//-------------------------------------------------------------------------

	/** specifies which user defined sorting list is used.

		<p>This property is only used, if
		<member>SheetSortDescriptor::IsUserListEnabled</member> is <TRUE/>.</p>
	 */
	[property] long UserListIndex;

	//-------------------------------------------------------------------------

	/** specifies if the sorted data should be copied to another
		position in the document.
	 */
	[property] boolean CopyOutputData;

	//-------------------------------------------------------------------------

	/** specifies the position where sorted data are to be copied.

		<p>This property is only used, if
		<member>SheetSortDescriptor::CopyOutputData</member> is <TRUE/>.</p>
	 */
	[property] com::sun::star::table::CellAddress OutputPosition;

};

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

}; }; }; };

#endif

