LibreOffice
LibreOffice 6.4 SDK API Reference
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 #ifndef __com_sun_star_sheet_XConsolidationDescriptor_idl__
21 #define __com_sun_star_sheet_XConsolidationDescriptor_idl__
22 
27 
28 
29 module com { module sun { module star { module sheet {
30 
31 
39 {
40 
44 
45 
49 
50 
53  sequence< com::sun::star::table::CellRangeAddress > getSources();
54 
55 
58  void setSources(
59  [in] sequence< com::sun::star::table::CellRangeAddress > aSources );
60 
61 
66 
67 
72  [in] com::sun::star::table::CellAddress aStartOutputPosition );
73 
74 
79 
80 
84  void setUseColumnHeaders( [in] boolean bUseColumnHeaders );
85 
86 
90  boolean getUseRowHeaders();
91 
92 
96  void setUseRowHeaders( [in] boolean bUseRowHeaders );
97 
98 
102  boolean getInsertLinks();
103 
104 
108  void setInsertLinks( [in] boolean bInsertLinks );
109 
110 };
111 
112 
113 }; }; }; };
114 
115 #endif
116 
117 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
XInterface.idl
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::getFunction
com::sun::star::sheet::GeneralFunction getFunction()
returns the function by which the ranges are consolidated.
com::sun::star::table::CellAddress
contains a cell address within a spreadsheet document.
Definition: CellAddress.idl:30
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
provides access to the settings of a consolidation descriptor.
Definition: XConsolidationDescriptor.idl:39
CellRangeAddress.idl
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::setFunction
void setFunction([in] com::sun::star::sheet::GeneralFunction nFunction)
sets the function by which the ranges are consolidated.
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::GeneralFunction
GeneralFunction
used to specify a function to be calculated from values.
Definition: GeneralFunction.idl:30
com::sun::star::sheet::XConsolidationDescriptor::getInsertLinks
boolean getInsertLinks()
returns, whether links to the original data are inserted in the output area or not.
com
Definition: Ambiguous.idl:22
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::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:48
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::setSources
void setSources([in] sequence< com::sun::star::table::CellRangeAddress > aSources)
sets the cell ranges which are consolidated.
CellAddress.idl
GeneralFunction.idl
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.