xref: /trunk/main/offapi/com/sun/star/table/TableSortDescriptor.idl (revision d1766043)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#ifndef __com_sun_star_table_TableSortDescriptor_idl__
#define __com_sun_star_table_TableSortDescriptor_idl__

#ifndef __com_sun_star_util_SortDescriptor_idl__
#include <com/sun/star/util/SortDescriptor.idl>
#endif

#ifndef __com_sun_star_util_SortField_idl__
#include <com/sun/star/util/SortField.idl>
#endif

#ifndef __com_sun_star_table_TableOrientation_idl__
#include <com/sun/star/table/TableOrientation.idl>
#endif

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

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

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

/** contains properties which describe sorting of rows or columns in a table.

	<p>It extends the general
	<type scope="com::sun::star::util">SortDescriptor</type> with
	table-specific properties.</p>

    @deprecated
 */
published service TableSortDescriptor
{
	//-------------------------------------------------------------------------

	/** contains common sorting properties.
	 */
	service com::sun::star::util::SortDescriptor;

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

	/** specifies the descriptions of the individual sort fields.
	 */
    [property] sequence<com::sun::star::util::SortField> SortFields;

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

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

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

	/** specifies the sorting orientation (sort rows or columns).

		<p>Some implementations may not support sorting columns.</p>

		@deprecated
		 use the property <member scope="com::sun::star::util">SortDescriptor::SortColumns</member>
		 instead.
	 */
	[property] com::sun::star::table::TableOrientation Orientation;

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

	/** specifies whether the first row or column (depending on
		<member scope="com::sun::star::util">SortDescriptor::SortColumns</member>) is a
		header which should not be sorted.
	 */
	[property] boolean ContainsHeader;

};

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

}; }; }; };

#endif