offapi/com/sun/star/sheet/DatabaseRange.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: DatabaseRange.idl,v $
  10  * $Revision: 1.15.114.1 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_sheet_DatabaseRange_idl__
  31 #define __com_sun_star_sheet_DatabaseRange_idl__
  32
  33 #ifndef __com_sun_star_sheet_XDatabaseRange_idl__
  34 #include <com/sun/star/sheet/XDatabaseRange.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_sheet_XCellRangeReferrer_idl__
  38 #include <com/sun/star/sheet/XCellRangeReferrer.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_beans_XPropertySet_idl__
  42 #include <com/sun/star/beans/XPropertySet.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_container_XNamed_idl__
  46 #include <com/sun/star/container/XNamed.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_util_XRefreshable_idl__
  50 #include <com/sun/star/util/XRefreshable.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_table_CellRangeAddress_idl__
  54 #include <com/sun/star/table/CellRangeAddress.idl>
  55 #endif
  56
  57
  58 //=============================================================================
  59
  60  module com {  module sun {  module star {  module sheet {
  61
  62 //=============================================================================
  63
  64 /** represents a database range in a spreadsheet document.
  65
  66     <p>A database range is a name for a cell range that also stores filtering,
  67     sorting, subtotal and data import settings and options.</p>
  68
  69     @see com::sun::star::sheet::DatabaseRanges
  70  */
  71 published service DatabaseRange
  72 {
  73     // DocMerge: empty anyway
  74     interface com::sun::star::sheet::XDatabaseRange;
  75
  76     // DocMerge: empty anyway
  77     interface com::sun::star::sheet::XCellRangeReferrer;
  78
  79     // DocMerge: empty anyway
  80     interface com::sun::star::beans::XPropertySet;
  81
  82     // DocMerge: empty anyway
  83     interface com::sun::star::container::XNamed;
  84
  85     [optional] interface com::sun::star::util::XRefreshable;
  86
  87     //-------------------------------------------------------------------------
  88
  89     // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::MoveCells
  90     /** if this property is set, columns or rows are inserted or deleted
  91         when the size of the range is changed by an update operation.
  92      */
  93     [property] boolean MoveCells;
  94
  95     //-------------------------------------------------------------------------
  96
  97     // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::KeepFormats
  98     /** if this property is set, cell formats are extended
  99         when the size of the range is changed by an update operation.
 100      */
 101     [property] boolean KeepFormats;
 102
 103     //-------------------------------------------------------------------------
 104
 105     // DocMerge from xml: property com::sun::star::sheet::DatabaseRange::StripData
 106     /** if this property is set, the cell contents within the database
 107         range are left out when the document is saved.
 108      */
 109     [property] boolean StripData;
 110
 111     //-------------------------------------------------------------------------
 112
 113     /** specifies whether the AutoFilter is enabled or not.
 114
 115         @since OOo 1.1.2
 116      */
 117     [optional, property] boolean AutoFilter;
 118
 119     //-------------------------------------------------------------------------
 120
 121     /** specifies whether the filter criteria should be taken from a CellRange.
 122
 123         @since OOo 1.1.2
 124      */
 125     [optional, property] boolean UseFilterCriteriaSource;
 126
 127     //-------------------------------------------------------------------------
 128
 129     /** specifies the range where the filter can find the filter criterias.
 130         <p>This is only used if <member>SheetFilterDescriptor::UseFilterCriteriaSource</member> is <TRUE/>.</p>
 131
 132         @since OOo 1.1.2
 133      */
 134     [optional, property] com::sun::star::table::CellRangeAddress FilterCriteriaSource;
 135
 136     //-------------------------------------------------------------------------
 137
 138     /** specifies the time between two refresh actions in seconds.
 139
 140         @since OOo 2.0.0
 141      */
 142     [optional, property] long RefreshPeriod;
 143
 144     //-------------------------------------------------------------------------
 145
 146     /** specifies whether the imported data is only a selection of the database.
 147
 148         @since OOo 2.0.0
 149      */
 150     [optional, property] boolean FromSelection;
 151
 152     //-------------------------------------------------------------------------
 153
 154     /** returns the index used to refer to this range in token arrays.
 155
 156         <p>A token describing a database range shall contain the op-code
 157         obtained from the <const>FormulaMapGroupSpecialOffset::DB_AREA</const>
 158         and this index as data part.</p>
 159
 160         @see com::sun::star::sheet::FormulaToken
 161         @see com::sun::star::sheet::FormulaMapGroupSpecialOffset::DB_AREA
 162
 163         @since OOo 3.0
 164      */
 165     [optional, readonly, property] long TokenIndex;
 166 };
 167
 168 //=============================================================================
 169
 170 }; }; }; };
 171
 172 /*=============================================================================
 173
 174 =============================================================================*/
 175 #endif