summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/sheet/DataPilotTablePositionData.idl78
1 files changed, 78 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl
new file mode 100644
index 000000000..0cbcdecc2
--- /dev/null
+++ b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl
@@ -0,0 +1,78 @@
+/* -*- 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_DataPilotTablePositionData_idl__
+#define __com_sun_star_sheet_DataPilotTablePositionData_idl__
+
+#include <com/sun/star/sheet/DataPilotFieldFilter.idl>
+
+
+module com { module sun { module star { module sheet {
+
+
+/** This structure contains information on a cell within a DataPilot table.
+
+ <p>This structure contains information on a particular cell within a DataPilot
+ table, and is used to retrieve its metadata. The #PositionType
+ member specifies in which sub-area of the table the cell is positioned, which
+ in turn determines the type of metadata contained in the #PositionData
+ member.</p>
+
+ @see com::sun::star::sheet::DataPilotTablePositionType
+ @see com::sun::star::sheet::DataPiotTableResultData
+ @see com::sun::star::sheet::DataPiotTableHeaderData
+
+ @since OOo 3.0
+ */
+struct DataPilotTablePositionData
+{
+
+ /** This parameter specifies which sub-area of a DataPilot table a given
+ cell is positioned. See DataPilotTablePositionType
+ for how to interpret the value of this parameter.
+
+ @see com::sun::star::sheet::DataPilotTablePositionType
+ */
+ long PositionType;
+
+
+ /** <p>This member contains a structure of different types depending on the
+ position type specified in #PositionType member.</p>
+
+ <p>When the value of #PositionType is
+ DataPilotTablePositionType::RESULT, DataPilotTablePositionData::PositionData
+ contains an instance of type DataPilotTableResultData,
+ whereas when the value of DataPilotTablePositionData::PositionType
+ is either DataPilotTablePositionType::ROW_HEADER
+ or DataPilotTablePositionType::COLUMN_HEADER, then the
+ #PositionData member contains an instance of type
+ DataPilotTableHeaderData.</p>
+
+ @see com::sun::star::sheet::DataPiotTableResultData
+ @see com::sun::star::sheet::DataPiotTableHeaderData
+ */
+ any PositionData;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */