xref: /trunk/main/offapi/com/sun/star/table/TableSortDescriptor2.idl (revision 96af39f7)

/**************************************************************
 *
 * 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_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 OpenOffice 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