summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/DataPilotSourceDimension.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/DataPilotSourceDimension.idl
parentInitial commit. (diff)
downloadlibreoffice-upstream/4%7.4.7.tar.xz
libreoffice-upstream/4%7.4.7.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 '')
-rw-r--r--offapi/com/sun/star/sheet/DataPilotSourceDimension.idl138
1 files changed, 138 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl b/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl
new file mode 100644
index 000000000..5ef61f508
--- /dev/null
+++ b/offapi/com/sun/star/sheet/DataPilotSourceDimension.idl
@@ -0,0 +1,138 @@
+/* -*- 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_DataPilotSourceDimension_idl__
+#define __com_sun_star_sheet_DataPilotSourceDimension_idl__
+
+#include <com/sun/star/container/XNamed.idl>
+#include <com/sun/star/sheet/XHierarchiesSupplier.idl>
+#include <com/sun/star/util/XCloneable.idl>
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/sheet/DataPilotFieldOrientation.idl>
+#include <com/sun/star/sheet/GeneralFunction.idl>
+#include <com/sun/star/sheet/TableFilterField.idl>
+
+
+ module com { module sun { module star { module sheet {
+
+
+/** represents a dimension in a data pilot source.
+
+ <p>A dimension is equivalent to a column of a cell range in a spreadsheet
+ used for a data pilot field.</p>
+
+ <p>In more complex data sources, a dimension may contain several
+ hierarchies, which consolidate items of a complex data type, called
+ levels.</p>
+
+ <p>Example: In a database, a column contains date values. This column
+ will be a dimension of the data pilot source. One hierarchy may contain
+ the 3 levels year, month, day. Another hierarchy may contain the 2 levels
+ year and week number.</p>
+
+ @see com::sun::star::sheet::DataPilotSource
+ @see com::sun::star::sheet::DataPilotTable
+ */
+service DataPilotSourceDimension
+{
+
+ /** provides access to the name of the dimension, i.e. used in
+ collections.
+ */
+ interface com::sun::star::container::XNamed;
+
+
+ /** provides access to the collection of hierarchies of this dimension.
+ */
+ interface com::sun::star::sheet::XHierarchiesSupplier;
+
+
+ /** supports duplicating the dimension.
+
+ <p>A dimension may be used several times in a data pilot table,
+ i.e. as row field and data field.</p>
+ */
+ interface com::sun::star::util::XCloneable;
+
+
+//!published service PropertySet
+ /** provides access to the properties.
+ */
+ interface com::sun::star::beans::XPropertySet;
+
+
+ /** returns the name of the dimension from which this dimension was
+ cloned, or `NULL` if it was not cloned.
+ */
+ [readonly, property] com::sun::star::container::XNamed Original;
+
+
+ /** contains `TRUE` if this is the dimension used to layout the
+ different data dimensions.
+ */
+ [readonly, property] boolean IsDataLayoutDimension;
+
+
+ /** specifies where the dimension is used.
+ */
+ [property] com::sun::star::sheet::DataPilotFieldOrientation Orientation;
+
+
+ /** specifies the position of the dimension within its orientation.
+ */
+ [property] long Position;
+
+
+ /** specifies how data are aggregated.
+ */
+ [property] com::sun::star::sheet::GeneralFunction Function;
+
+
+ /** specifies which hierarchy of the dimension is used.
+
+ @see com::sun::star::sheet::DataPilotSourceHierarchies
+ */
+ [property] long UsedHierarchy;
+
+
+ /** specifies which values are used.
+ */
+ [property] sequence< com::sun::star::sheet::TableFilterField > Filter;
+
+
+ /** contains flags that control the usage of the dimension.
+
+ @see com::sun::star::sheet::DimensionFlags
+ */
+ [readonly, property, optional] long Flags;
+
+
+ /** specifies how data are aggregated.
+ @since LibreOffice 5.3
+ */
+ [property, optional] short Function2;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */