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
  20
  21
  22  module com {  module sun {  module star {  module sheet {
  23
  24
  25 /** represents a database range in a spreadsheet document.
  26
  27     <p>A database range is a name for a cell range that also stores filtering,
  28     sorting, subtotal and data import settings and options.</p>
  29
  30     @see com::sun::star::sheet::DatabaseRanges
  31  */
  32 published service DatabaseRange
  33 {
  34     interface com::sun::star::sheet::XDatabaseRange;
  35     interface com::sun::star::sheet::XCellRangeReferrer;
  36     interface com::sun::star::beans::XPropertySet;
  37     interface com::sun::star::container::XNamed;
  38
  39     [optional] interface com::sun::star::util::XRefreshable;
  40
  41     /** if this property is set, columns or rows are inserted or deleted
  42         when the size of the range is changed by an update operation.
  43      */
  44     [property] boolean MoveCells;
  45
  46     /** if this property is set, cell formats are extended
  47         when the size of the range is changed by an update operation.
  48      */
  49     [property] boolean KeepFormats;
  50
  51     /** if this property is set, the cell contents within the database
  52         range are left out when the document is saved.
  53      */
  54     [property] boolean StripData;
  55
  56
  57     /** specifies whether the AutoFilter is enabled or not.
  58
  59         @since OOo 1.1.2
  60      */
  61     [optional, property] boolean AutoFilter;
  62
  63
  64     /** specifies whether the filter criteria should be taken from a CellRange.
  65
  66         @since OOo 1.1.2
  67      */
  68     [optional, property] boolean UseFilterCriteriaSource;
  69
  70
  71     /** specifies the range where the filter can find the filter criteria.
  72         <p>This is only used if SheetFilterDescriptor::UseFilterCriteriaSource is `TRUE`.</p>
  73
  74         @since OOo 1.1.2
  75      */
  76     [optional, property] com::sun::star::table::CellRangeAddress FilterCriteriaSource;
  77
  78
  79     /** specifies the time between two refresh actions in seconds.
  80
  81         @since OOo 2.0
  82      */
  83     [optional, property] long RefreshPeriod;
  84
  85
  86     /** specifies whether the imported data is only a selection of the database.
  87
  88         @since OOo 2.0
  89      */
  90     [optional, property] boolean FromSelection;
  91
  92
  93     /** returns the index used to refer to this range in token arrays.
  94
  95         <p>A token describing a database range shall contain the op-code
  96         obtained from the FormulaMapGroupSpecialOffset::DB_AREA
  97         and this index as data part.</p>
  98
  99         @see com::sun::star::sheet::FormulaToken
 100         @see com::sun::star::sheet::FormulaMapGroupSpecialOffset::DB_AREA
 101
 102         @since OOo 3.0
 103      */
 104     [optional, readonly, property] long TokenIndex;
 105
 106
 107     /** specifies whether this range includes a bottom row of totals.
 108
 109         @since LibreOffice 5.0
 110      */
 111     [optional, property] boolean TotalsRow;
 112
 113
 114     /** specifies whether this range includes a top row of headers.
 115
 116         @since LibreOffice 5.0
 117      */
 118     [optional, property] boolean ContainsHeader;
 119 };
 120
 121
 122 }; }; }; };
 123
 124 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */