AOO410/main/offapi/com/sun/star/sheet/DataPilotOutputRangeType.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_DataPilotOutputRangeType_idl__
#define __com_sun_star_sheet_DataPilotOutputRangeType_idl__

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

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

/** specifies region type of DataPilot table range

    <p>This constant set is used to indicate the type of output range desired when
    <method>XDataPilotTable2::getOutputRangeByType</method> is called, which 
    returns a different cell range depending upon the value passed to it as the argument.</p>

    @see com::sun::star::sheet::XDataPilotTable2

    @since OpenOffice 3.0
 */
constants DataPilotOutputRangeType
{
    //------------------------------------------------------------------------

    /** whole DataPilot output range including the header area above the table
        where the filter and page field buttons are located. */
    const long WHOLE = 0;

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

    /** whole table but without the header area where the filter and page field 
        buttons are located. */
    const long TABLE = 1;

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

    /** result area where the result values are displayed.  This also includes
        the column and row subtotal areas when they are displayed. */
    const long RESULT = 2;
};

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

}; }; }; };



#endif