office-gobmx/offapi/com/sun/star/sheet/DatabaseRange.idl
Oliver Bolte 4bde6ad8d3 INTEGRATION: CWS sb18 (1.10.76); FILE MERGED
2004/05/21 15:02:46 sb 1.10.76.1: #i21150# Added published flag.
2004-06-03 21:37:36 +00:00

192 lines
6.6 KiB
Text

/*************************************************************************
*
* $RCSfile: DatabaseRange.idl,v $
*
* $Revision: 1.11 $
*
* last change: $Author: obo $ $Date: 2004-06-03 22:37:36 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
*
* - GNU Lesser General Public License Version 2.1
* - Sun Industry Standards Source License Version 1.1
*
* Sun Microsystems Inc., October, 2000
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2000 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
*
*
* Sun Industry Standards Source License Version 1.1
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.1 (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.openoffice.org/license.html.
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2000 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
* Contributor(s): _______________________________________
*
*
************************************************************************/
#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 #107627#
*/
[optional, property] boolean AutoFilter;
//-------------------------------------------------------------------------
/** specifies whether the filter criteria should be taken from a CellRange.
@since #107627#
*/
[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 #107627#
*/
[optional, property] com::sun::star::table::CellRangeAddress FilterCriteriaSource;
//-------------------------------------------------------------------------
/** specifies the time between two refresh actions in seconds.
@since #76694#
*/
[optional, property] long RefreshPeriod;
//-------------------------------------------------------------------------
/** specifies whether the imported data is only a selection of the database.
@since #76694#
*/
[optional, property] boolean FromSelection;
};
//=============================================================================
}; }; }; };
/*=============================================================================
=============================================================================*/
#endif