AOO410/main/offapi/com/sun/star/sheet/DataPilotFieldSortInfo.idl

/**************************************************************
 * 
 * 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_sheet_DataPilotFieldSortInfo_idl__
#define __com_sun_star_sheet_DataPilotFieldSortInfo_idl__

#ifndef __com_sun_star_sheet_DataPilotFieldSortMode_idl__
#include <com/sun/star/sheet/DataPilotFieldSortMode.idl>
#endif

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

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

//=============================================================================
/** describes how to sort a single DataPilotField
 */
published struct DataPilotFieldSortInfo
{
    //-------------------------------------------------------------------------

    /** contains the data field to sort by if the Mode is DATA
     */

    string Field;

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

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

    boolean IsAscending;

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

    /** contains the sort mode

    @see com::sun::star::sheet::DataPilotFieldSortMode

     */

    long Mode;

};

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

}; }; }; };

#endif