LibreOffice: com/sun/star/sheet/DatabaseRange.idl Source File

LibreOffice LibreOffice 7.3 SDK API Reference

DatabaseRange.idl
Go to the documentation of this file.
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
41published 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
53 [property] boolean MoveCells;
54
58 [property] boolean KeepFormats;
59
63 [property] boolean StripData;
64
65
70 [optional, property] boolean AutoFilter;
71
72
77 [optional, property] boolean UseFilterCriteriaSource;
78
79
85 [optional, property] com::sun::star::table::CellRangeAddress FilterCriteriaSource;
86
87
92 [optional, property] long RefreshPeriod;
93
94
99 [optional, property] boolean FromSelection;
100
101
113 [optional, readonly, property] long TokenIndex;
114
115
120 [optional, property] boolean TotalsRow;
121
122
127 [optional, property] boolean ContainsHeader;
128};
129
130
131}; }; }; };
132
133#endif
134
135/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
CellRangeAddress.idl
XCellRangeReferrer.idl
XDatabaseRange.idl
XNamed.idl
XPropertySet.idl
XRefreshable.idl
com::sun::star::beans::XPropertySet
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
com::sun::star::container::XNamed
specifies the name of the object.
Definition: XNamed.idl:33
com::sun::star::sheet::XCellRangeReferrer
allows direct access to the cells in a named range or to the cells which are visible in a view,...
Definition: XCellRangeReferrer.idl:39
com::sun::star::sheet::XDatabaseRange
provides access to the settings and options of a database range.
Definition: XDatabaseRange.idl:38
com::sun::star::util::XRefreshable
is supported by objects with data that can be refreshed from a data source.
Definition: XRefreshable.idl:34
com
Definition: Ambiguous.idl:22
com::sun::star::sheet::DatabaseRange
represents a database range in a spreadsheet document.
Definition: DatabaseRange.idl:42
com::sun::star::sheet::DatabaseRange::AutoFilter
boolean AutoFilter
specifies whether the AutoFilter is enabled or not.
Definition: DatabaseRange.idl:70
com::sun::star::sheet::DatabaseRange::TotalsRow
boolean TotalsRow
specifies whether this range includes a bottom row of totals.
Definition: DatabaseRange.idl:120
com::sun::star::sheet::DatabaseRange::ContainsHeader
boolean ContainsHeader
specifies whether this range includes a top row of headers.
Definition: DatabaseRange.idl:127
com::sun::star::sheet::DatabaseRange::UseFilterCriteriaSource
boolean UseFilterCriteriaSource
specifies whether the filter criteria should be taken from a CellRange.
Definition: DatabaseRange.idl:77
com::sun::star::sheet::DatabaseRange::MoveCells
boolean MoveCells
if this property is set, columns or rows are inserted or deleted when the size of the range is change...
Definition: DatabaseRange.idl:48
com::sun::star::sheet::DatabaseRange::FromSelection
boolean FromSelection
specifies whether the imported data is only a selection of the database.
Definition: DatabaseRange.idl:99
com::sun::star::sheet::DatabaseRange::StripData
boolean StripData
if this property is set, the cell contents within the database range are left out when the document i...
Definition: DatabaseRange.idl:63
com::sun::star::sheet::DatabaseRange::RefreshPeriod
long RefreshPeriod
specifies the time between two refresh actions in seconds.
Definition: DatabaseRange.idl:92
com::sun::star::sheet::DatabaseRange::FilterCriteriaSource
com::sun::star::table::CellRangeAddress FilterCriteriaSource
specifies the range where the filter can find the filter criteria.
Definition: DatabaseRange.idl:85
com::sun::star::sheet::DatabaseRange::KeepFormats
boolean KeepFormats
if this property is set, cell formats are extended when the size of the range is changed by an update...
Definition: DatabaseRange.idl:58
com::sun::star::sheet::DatabaseRange::TokenIndex
long TokenIndex
returns the index used to refer to this range in token arrays.
Definition: DatabaseRange.idl:113
com::sun::star::table::CellRangeAddress
contains a cell range address within a spreadsheet document.
Definition: CellRangeAddress.idl:30