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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_sheet_DatabaseRange_idl__
  20 #define __com_sun_star_sheet_DatabaseRange_idl__
  21
  22 #include <com/sun/star/sheet/XDatabaseRange.idl>
  23 #include <com/sun/star/sheet/XCellRangeReferrer.idl>
  24 #include <com/sun/star/beans/XPropertySet.idl>
  25 #include <com/sun/star/container/XNamed.idl>
  26 #include <com/sun/star/util/XRefreshable.idl>
  27 #include <com/sun/star/table/CellRangeAddress.idl>
  28
  29
  30
  31  module com {  module sun {  module star {  module sheet {
  32
  33
  34 /** represents a database range in a spreadsheet document.
  35
  36     <p>A database range is a name for a cell range that also stores filtering,
  37     sorting, subtotal and data import settings and options.</p>
  38
  39     @see com::sun::star::sheet::DatabaseRanges
  40  */
  41 published service DatabaseRange
  42 {
  43     interface com::sun::star::sheet::XDatabaseRange;
  44     interface com::sun::star::sheet::XCellRangeReferrer;
  45     interface com::sun::star::beans::XPropertySet;
  46     interface com::sun::star::container::XNamed;
  47
  48     [optional] interface com::sun::star::util::XRefreshable;
  49
  50     /** if this property is set, columns or rows are inserted or deleted
  51         when the size of the range is changed by an update operation.
  52      */
  53     [property] boolean MoveCells;
  54
  55     /** if this property is set, cell formats are extended
  56         when the size of the range is changed by an update operation.
  57      */
  58     [property] boolean KeepFormats;
  59
  60     /** if this property is set, the cell contents within the database
  61         range are left out when the document is saved.
  62      */
  63     [property] boolean StripData;
  64
  65
  66     /** specifies whether the AutoFilter is enabled or not.
  67
  68         @since OOo 1.1.2
  69      */
  70     [optional, property] boolean AutoFilter;
  71
  72
  73     /** specifies whether the filter criteria should be taken from a CellRange.
  74
  75         @since OOo 1.1.2
  76      */
  77     [optional, property] boolean UseFilterCriteriaSource;
  78
  79
  80     /** specifies the range where the filter can find the filter criteria.
  81         <p>This is only used if SheetFilterDescriptor::UseFilterCriteriaSource is `TRUE`.</p>
  82
  83         @since OOo 1.1.2
  84      */
  85     [optional, property] com::sun::star::table::CellRangeAddress FilterCriteriaSource;
  86
  87
  88     /** specifies the time between two refresh actions in seconds.
  89
  90         @since OOo 2.0
  91      */
  92     [optional, property] long RefreshPeriod;
  93
  94
  95     /** specifies whether the imported data is only a selection of the database.
  96
  97         @since OOo 2.0
  98      */
  99     [optional, property] boolean FromSelection;
 100
 101
 102     /** returns the index used to refer to this range in token arrays.
 103
 104         <p>A token describing a database range shall contain the op-code
 105         obtained from the FormulaMapGroupSpecialOffset::DB_AREA
 106         and this index as data part.</p>
 107
 108         @see com::sun::star::sheet::FormulaToken
 109         @see com::sun::star::sheet::FormulaMapGroupSpecialOffset::DB_AREA
 110
 111         @since OOo 3.0
 112      */
 113     [optional, readonly, property] long TokenIndex;
 114
 115
 116     /** specifies whether this range includes a bottom row of totals.
 117
 118         @since LibreOffice 5.0
 119      */
 120     [optional, property] boolean TotalsRow;
 121
 122
 123     /** specifies whether this range includes a top row of headers.
 124
 125         @since LibreOffice 5.0
 126      */
 127     [optional, property] boolean ContainsHeader;
 128 };
 129
 130
 131 }; }; }; };
 132
 133 #endif
 134
 135 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */