diff options
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/sheet/ExternalReference.idl | 81 |
1 files changed, 81 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/ExternalReference.idl b/offapi/com/sun/star/sheet/ExternalReference.idl new file mode 100644 index 000000000..ea2225708 --- /dev/null +++ b/offapi/com/sun/star/sheet/ExternalReference.idl @@ -0,0 +1,81 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ + +#ifndef __com_sun_star_sheet_ExternalReference_idl__ +#define __com_sun_star_sheet_ExternalReference_idl__ + +module com { module sun { module star { module sheet { + + +/** Data structure to store information about an external reference. An + external reference can be either a single cell reference, a cell range + reference, or a named range. + + @see FormulaMapGroupSpecialOffset::PUSH + + @since OOo 3.1 + */ +struct ExternalReference +{ + + /** Index of an externally linked document. Each externally-linked document + has a unique index value. + + <p>You can get the index value of an external document from the + corresponding com::sun::star::sheet::ExternalDocLink + instance through its attribute com::sun::star::sheet::ExternalDocLink::TokenIndex.</p> + + @see com::sun::star::sheet::ExternalDocLink + @see com::sun::star::sheet::ExternalDocLink::TokenIndex + */ + long Index; + +// /** Name of the sheet that the external reference points to. +// +// <p>In case of a cell range reference that spans across multiple +// sheets, this is the name of the first sheet in that range.</p> +// +// <p>Note that an external range name ignores this value at the moment, +// but <i>it may make use of this data in the future when Calc supports a +// sheet-specific range name.</i></p> +// */ +// string SheetName; + + /** Reference data. + + <p>This can store either SingleReference for a single + cell reference, ComplexReference for a cell range + reference, or simply a string for a defined name.</p> + + <p>The SingleReference::Sheet member shall contain + the index of the external sheet cache containing the values of the + externally referenced cells.</p> + + @see com::sun::star::sheet::SingleReference + @see com::sun::star::sheet::ComplexReference + */ + any Reference; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |