diff options
Diffstat (limited to '')
-rw-r--r-- | offapi/com/sun/star/sheet/XSheetCellRanges.idl | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/XSheetCellRanges.idl b/offapi/com/sun/star/sheet/XSheetCellRanges.idl new file mode 100644 index 000000000..8ad3fc491 --- /dev/null +++ b/offapi/com/sun/star/sheet/XSheetCellRanges.idl @@ -0,0 +1,71 @@ +/* -*- 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_XSheetCellRanges_idl__ +#define __com_sun_star_sheet_XSheetCellRanges_idl__ + +#include <com/sun/star/container/XIndexAccess.idl> +#include <com/sun/star/container/XEnumerationAccess.idl> +#include <com/sun/star/table/CellRangeAddress.idl> + + +module com { module sun { module star { module sheet { + + +/** provides methods to access cell ranges in a collection via index and + other helper methods. + + @see com::sun::star::sheet::SheetCellRanges + */ +published interface XSheetCellRanges: com::sun::star::container::XIndexAccess +{ + + /** returns the collection of all used cells. + + @see com::sun::star::sheet::Cells + */ + com::sun::star::container::XEnumerationAccess getCells(); + + + /** creates a string with addresses of all contained cell ranges. + + <p>The range addresses are separated with semicolons. For instance + the string could have the form "Sheet1.A1:C3;Sheet2.D5:F8".</p> + + @returns + a string containing the addresses of all cell ranges. + */ + string getRangeAddressesAsString(); + + + /** creates a sequence with addresses of all contained cell ranges. + + @returns + a sequence with the addresses of all cell ranges. + */ + sequence<com::sun::star::table::CellRangeAddress> getRangeAddresses(); + +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ |