summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/SheetCell.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/sheet/SheetCell.idl
parentInitial commit. (diff)
downloadlibreoffice-upstream.tar.xz
libreoffice-upstream.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/sheet/SheetCell.idl')
-rw-r--r--offapi/com/sun/star/sheet/SheetCell.idl262
1 files changed, 262 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/SheetCell.idl b/offapi/com/sun/star/sheet/SheetCell.idl
new file mode 100644
index 000000000..0f3303c49
--- /dev/null
+++ b/offapi/com/sun/star/sheet/SheetCell.idl
@@ -0,0 +1,262 @@
+/* -*- 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_SheetCell_idl__
+#define __com_sun_star_sheet_SheetCell_idl__
+
+
+#include <com/sun/star/table/Cell.idl>
+#include <com/sun/star/text/Text.idl>
+#include <com/sun/star/style/CharacterProperties.idl>
+#include <com/sun/star/style/CharacterPropertiesAsian.idl>
+#include <com/sun/star/style/CharacterPropertiesComplex.idl>
+#include <com/sun/star/style/ParagraphProperties.idl>
+#include <com/sun/star/style/ParagraphPropertiesAsian.idl>
+#include <com/sun/star/style/ParagraphPropertiesComplex.idl>
+#include <com/sun/star/sheet/SheetRangesQuery.idl>
+
+
+#include <com/sun/star/document/XActionLockable.idl>
+#include <com/sun/star/util/XReplaceable.idl>
+#include <com/sun/star/util/XIndent.idl>
+#include <com/sun/star/table/XColumnRowRange.idl>
+#include <com/sun/star/sheet/XCellAddressable.idl>
+#include <com/sun/star/sheet/XSheetAnnotationAnchor.idl>
+#include <com/sun/star/text/XTextFieldsSupplier.idl>
+
+
+#include <com/sun/star/awt/Point.idl>
+#include <com/sun/star/awt/Size.idl>
+#include <com/sun/star/table/CellContentType.idl>
+#include <com/sun/star/sheet/XSheetConditionalEntries.idl>
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/beans/XTolerantMultiPropertySet.idl>
+#include <com/sun/star/util/XModifyBroadcaster.idl>
+
+
+module com { module sun { module star { module sheet {
+
+
+/** represents a single addressable cell in a spreadsheet document.
+ */
+published service SheetCell
+{
+
+ /** provides basic cell handling and contributes common cell
+ formatting properties.
+ */
+ service com::sun::star::table::Cell;
+
+
+ /** provides handling of formatted text cells.
+ */
+ service com::sun::star::text::Text;
+
+
+ /** contributes properties for character formatting of Western text.
+ */
+ service com::sun::star::style::CharacterProperties;
+
+
+ /** contributes properties for character formatting of Asian text.
+ */
+ service com::sun::star::style::CharacterPropertiesAsian;
+
+
+ /** contributes properties for character formatting of Complex text.
+ */
+ service com::sun::star::style::CharacterPropertiesComplex;
+
+
+ /** contributes properties for paragraph formatting.
+ */
+ service com::sun::star::style::ParagraphProperties;
+
+
+ /** contributes properties for paragraph formatting of Asian text.
+ */
+ [optional] service com::sun::star::style::ParagraphPropertiesAsian;
+
+
+ /** contributes properties for paragraph formatting of Complex text.
+ */
+ [optional] service com::sun::star::style::ParagraphPropertiesComplex;
+
+
+ /** provides interfaces to find cells with specific properties.
+ */
+ service com::sun::star::sheet::SheetRangesQuery;
+
+
+ /** provides methods to lock and unlock the update between
+ com::sun::star::table::XCell and
+ com::sun::star::text::XText.
+ */
+ interface com::sun::star::document::XActionLockable;
+
+
+ /** provides "Find and Replace" functionality.
+
+ <p>The property
+ com::sun::star::util::SearchDescriptor::SearchWords
+ has a different meaning in spreadsheets: If set to `TRUE`, the
+ spreadsheet searches for cells containing the search text only.</p>
+ */
+ interface com::sun::star::util::XReplaceable;
+
+
+ /** provides modifying the cell indentation.
+ */
+ interface com::sun::star::util::XIndent;
+
+
+ /** provides access to the collections of columns and rows.
+ */
+ interface com::sun::star::table::XColumnRowRange;
+
+
+ /** provides access to the cell address of this cell.
+ */
+ interface com::sun::star::sheet::XCellAddressable;
+
+
+ /** provides access to the annotation attached to this cell.
+ */
+ interface com::sun::star::sheet::XSheetAnnotationAnchor;
+
+
+ /** provides access to the text fields used in this cell.
+
+ <p>With com::sun::star::text::XTextFieldsSupplier::getTextFieldMasters
+ always returns void since the field master is not supported.</p>
+ */
+ interface com::sun::star::text::XTextFieldsSupplier;
+
+
+ [optional] interface com::sun::star::beans::XTolerantMultiPropertySet;
+
+
+ /**
+
+ @since OOo 2.0
+
+ */
+ [optional] interface com::sun::star::util::XModifyBroadcaster;
+
+
+ /** contains the position of this cell in the sheet (in 1/100 mm).
+
+ <p>This property contains the absolute position in the whole
+ sheet, not the position in the visible area.</p>
+ */
+ [readonly, property] com::sun::star::awt::Point Position;
+
+
+ /** contains the size of this cell (in 1/100 mm).
+ */
+ [readonly, property] com::sun::star::awt::Size Size;
+
+
+ /** contains the formula string with localized function names.
+
+ <p>This property can also be used to set a new localized formula.</p>
+ */
+ [optional, property] string FormulaLocal;
+
+
+ /** contains the content type of the cell.
+
+ <p>This property returns not com::sun::star::sheet::FormulaResult
+ but instead com::sun::star::table::CellContentType. Use FormulaResult2
+ if the correct property is needed.</p>
+ */
+ [readonly, property] long FormulaResultType;
+
+
+ /** contains the conditional formatting settings for this cell.
+
+ <p>After a conditional format has been changed it has to be
+ reinserted into the property set.</p>
+
+ @see com::sun::star::sheet::TableConditionalFormat
+ */
+ [property] com::sun::star::sheet::XSheetConditionalEntries
+ ConditionalFormat;
+
+
+ /** contains the conditional formatting settings for this cell,
+ using localized formulas.
+
+ <p>After a conditional format has been changed it has to be
+ reinserted into the property set.</p>
+
+ @see com::sun::star::sheet::TableConditionalFormat
+ */
+ [optional, property] com::sun::star::sheet::XSheetConditionalEntries
+ ConditionalFormatLocal;
+
+
+ /** contains the data validation settings for this cell.
+
+ <p>After the data validation settings have been changed the
+ validation has to be reinserted into the property set.</p>
+
+ @see com::sun::star::sheet::TableValidation
+ */
+ [property] com::sun::star::beans::XPropertySet Validation;
+
+
+ /** contains the data validation settings for this cell,
+ using localized formulas.
+
+ <p>After the data validation settings have been changed the
+ validation has to be reinserted into the property set.</p>
+
+ @see com::sun::star::sheet::TableValidation
+ */
+ [optional, property] com::sun::star::beans::XPropertySet ValidationLocal;
+
+
+ /** Returns the absolute address of the range as string, e.g. "$Sheet1.$B$2".
+ */
+ [optional, readonly, property] string AbsoluteName;
+
+
+ /** contains the content type of the cell.
+
+ @see com::sun::star::table::CellContentType
+ @since LibreOffice 6.1
+ */
+ [optional, readonly, property] com::sun::star::table::CellContentType CellContentType;
+
+
+ /** contains the result type of a formula.
+
+ @see com::sun::star::sheet::FormulaResult
+ @since LibreOffice 6.1
+ */
+ [optional, readonly, property] long FormulaResultType2;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */