LibreOffice LibreOffice 24.2 SDK API Reference

Loading...
Searching...
No Matches
XConsolidationDescriptor.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
20
21module com { module sun { module star { module sheet {
22
23
30published interface XConsolidationDescriptor: com::sun::star::uno::XInterface
31{
32
35 com::sun::star::sheet::GeneralFunction getFunction();
36
37
40 void setFunction( [in] com::sun::star::sheet::GeneralFunction nFunction );
41
42
45 sequence< com::sun::star::table::CellRangeAddress > getSources();
46
47
50 void setSources(
51 [in] sequence< com::sun::star::table::CellRangeAddress > aSources );
52
53
57 com::sun::star::table::CellAddress getStartOutputPosition();
58
59
63 void setStartOutputPosition(
64 [in] com::sun::star::table::CellAddress aStartOutputPosition );
65
66
70 boolean getUseColumnHeaders();
71
72
76 void setUseColumnHeaders( [in] boolean bUseColumnHeaders );
77
78
82 boolean getUseRowHeaders();
83
84
88 void setUseRowHeaders( [in] boolean bUseRowHeaders );
89
90
94 boolean getInsertLinks();
95
96
100 void setInsertLinks( [in] boolean bInsertLinks );
101
102};
103
104
105}; }; }; };
106
107/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::sheet::XConsolidationDescriptor
provides access to the settings of a consolidation descriptor.
Definition XConsolidationDescriptor.idl:31
com::sun::star::sheet::XConsolidationDescriptor::getUseRowHeaders
boolean getUseRowHeaders()
returns, whether row headers from the cell ranges are used to find matching data or not.
com::sun::star::sheet::XConsolidationDescriptor::getUseColumnHeaders
boolean getUseColumnHeaders()
returns, whether column headers from the cell ranges are used to find matching data or not.
com::sun::star::sheet::XConsolidationDescriptor::setSources
void setSources([in] sequence< com::sun::star::table::CellRangeAddress > aSources)
sets the cell ranges which are consolidated.
com::sun::star::sheet::XConsolidationDescriptor::setStartOutputPosition
void setStartOutputPosition([in] com::sun::star::table::CellAddress aStartOutputPosition)
sets the position of the top left cell of the cell range where the consolidated data are copied.
com::sun::star::sheet::XConsolidationDescriptor::setFunction
void setFunction([in] com::sun::star::sheet::GeneralFunction nFunction)
sets the function by which the ranges are consolidated.
com::sun::star::sheet::XConsolidationDescriptor::getFunction
com::sun::star::sheet::GeneralFunction getFunction()
returns the function by which the ranges are consolidated.
com::sun::star::sheet::XConsolidationDescriptor::setInsertLinks
void setInsertLinks([in] boolean bInsertLinks)
specifies if links to the original data are inserted in the output area.
com::sun::star::sheet::XConsolidationDescriptor::setUseColumnHeaders
void setUseColumnHeaders([in] boolean bUseColumnHeaders)
specifies if column headers from the cell ranges are used to find matching data.
com::sun::star::sheet::XConsolidationDescriptor::getSources
sequence< com::sun::star::table::CellRangeAddress > getSources()
returns the cell ranges which are consolidated.
com::sun::star::sheet::XConsolidationDescriptor::getStartOutputPosition
com::sun::star::table::CellAddress getStartOutputPosition()
returns the position of the top left cell of the cell range where the consolidated data are copied.
com::sun::star::sheet::XConsolidationDescriptor::setUseRowHeaders
void setUseRowHeaders([in] boolean bUseRowHeaders)
specifies if row headers from the cell ranges are used to find matching data.
com::sun::star::sheet::XConsolidationDescriptor::getInsertLinks
boolean getInsertLinks()
returns, whether links to the original data are inserted in the output area or not.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition XInterface.idl:46
com::sun::star::sheet::GeneralFunction
GeneralFunction
used to specify a function to be calculated from values.
Definition GeneralFunction.idl:27
com
Definition Ambiguous.idl:20
com::sun::star::table::CellAddress
contains a cell address within a spreadsheet document.
Definition CellAddress.idl:27