/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: DatabaseRange.idl,v $
 *
 *  $Revision: 1.13 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 04:37:50 $
 *
 *  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_DatabaseRange_idl__
#define __com_sun_star_sheet_DatabaseRange_idl__

#ifndef __com_sun_star_sheet_XDatabaseRange_idl__
#include <com/sun/star/sheet/XDatabaseRange.idl>
#endif

#ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__
#include <com/sun/star/sheet/XCellRangeReferrer.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_container_XNamed_idl__
#include <com/sun/star/container/XNamed.idl>
#endif

#ifndef __com_sun_star_util_XRefreshable_idl__
#include <com/sun/star/util/XRefreshable.idl>
#endif

#ifndef __com_sun_star_table_CellRangeAddress_idl__
#include <com/sun/star/table/CellRangeAddress.idl>
#endif


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

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

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

/** represents a database range in a spreadsheet document.

    <p>A database range is a name for a cell range that also stores filtering,
    sorting, subtotal and data import settings and options.</p>

    @see com::sun::star::sheet::DatabaseRanges
 */
published service DatabaseRange
{
    // DocMerge: empty anyway
    interface com::sun::star::sheet::XDatabaseRange;

    // DocMerge: empty anyway
    interface com::sun::star::sheet::XCellRangeReferrer;

    // DocMerge: empty anyway
    interface com::sun::star::beans::XPropertySet;

    // DocMerge: empty anyway
    interface com::sun::star::container::XNamed;

    [optional] interface com::sun::star::util::XRefreshable;

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

    // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::MoveCells
    /** if this property is set, columns or rows are inserted or deleted
        when the size of the range is changed by an update operation.
     */
    [property] boolean MoveCells;

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

    // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::KeepFormats
    /** if this property is set, cell formats are extended
        when the size of the range is changed by an update operation.
     */
    [property] boolean KeepFormats;

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

    // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::StripData
    /** if this property is set, the cell contents within the database
        range are left out when the document is saved.
     */
    [property] boolean StripData;

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

    /** specifies whether the AutoFilter is enabled or not.

        @since OOo 1.1.2
     */
    [optional, property] boolean AutoFilter;

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

    /** specifies whether the filter criteria should be taken from a CellRange.

        @since OOo 1.1.2
     */
    [optional, property] boolean UseFilterCriteriaSource;

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

    /** specifies the range where the filter can find the filter criterias.
        <p>This is only used if <member>SheetFilterDescriptor::UseFilterCriteriaSource</member> is <TRUE/>.</p>

        @since OOo 1.1.2
     */
    [optional, property] com::sun::star::table::CellRangeAddress FilterCriteriaSource;

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

    /** specifies the time between two refresh actions in seconds.

        @since OOo 2.0.0
     */
    [optional, property] long RefreshPeriod;

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

    /** specifies whether the imported data is only a selection of the database.

        @since OOo 2.0.0

     */
    [optional, property] boolean FromSelection;
};

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

}; }; }; };

/*=============================================================================

=============================================================================*/
#endif
