INTEGRATION: CWS koheidatapilot01 (1.1.2); FILE ADDED

2008/05/20 12:57:50 kz 1.1.2.6: updated license header
2007/12/07 05:29:36 kohei 1.1.2.5: removed explicit scopes from elements whose scopes are com::sun::star::sheet, added more annotations for XDataPilotTable2 interface.
2007/12/06 23:08:29 kohei 1.1.2.4: more javadoc comments added.
2007/12/06 22:19:05 kohei 1.1.2.3: more javadoc comments for the new API.
2007/11/30 05:10:20 kohei 1.1.2.2: included license headers & added javadoc description (not done yet).
2007/11/08 17:56:41 kohei 1.1.2.1: added more UNO interface & modified some to allow retrieving position data based on cell positions withth data pilot table.

1 files changed, 94 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 000000000000..3dcf165fc39f
--- /dev/null
+++ b/offapi/com/sun/star/sheet/DataPilotTablePositionData.idl
@@ -0,0 +1,94 @@
+/*************************************************************************
+ *
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * Copyright 2008 by Sun Microsystems, Inc.
+ *
+ * OpenOffice.org - a multi-platform office productivity suite
+ *
+ * $RCSfile: DataPilotTablePositionData.idl,v $
+ *
+ * $Revision: 1.2 $
+ *
+ * This file is part of OpenOffice.org.
+ *
+ * OpenOffice.org is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 3
+ * only, as published by the Free Software Foundation.
+ *
+ * OpenOffice.org is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License version 3 for more details
+ * (a copy is included in the LICENSE file that accompanied this code).
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * version 3 along with OpenOffice.org.  If not, see
+ * <http://www.openoffice.org/license.html>
+ * for a copy of the LGPLv3 License.
+ *
+ ************************************************************************/
+
+#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 <member>PositionType</member>
+    member specifies in which sub-area of the table the cell is positioned, which
+    in turn determines the type of metadata contained in the <member>PositionData</member>
+    member.</p>
+
+    @see com::sun::star::sheet::DataPilotTablePositionType
+    @see com::sun::star::sheet::DataPiotTableResultData
+    @see com::sun::star::sheet::DataPiotTableHeaderData
+
+    @since OOo 3.0.0
+ */
+struct DataPilotTablePositionData
+{
+    //-------------------------------------------------------------------------
+
+    /** This parameter specifies which sub-area of a DataPilot table a given
+        cell is positioned.  See <type>DataPilotTablePositionType</type>
+        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 <member>PositionType</member> member.</p>
+
+        <p>When the value of <member>PositionType</member> is
+        <const>DataPilotTablePositionType::RESULT</const>, <member>DataPilotTablePositionData::PositionData</member>
+        contains an instance of type <type>DataPilotTableResultData</type>,
+        whereas when the value of <member>DataPilotTablePositionData::PositionType</member>
+        is either <const>DataPilotTablePositionType::ROW_HEADER</const>
+        or <const>DataPilotTablePositionType::COLUMN_HEADER</const>, then the
+        <member>PositionData</member> member contains an instance of type <type>
+        DataPilotTableHeaderData</type>.</p>
+
+        @see com::sun::star::sheet::DataPiotTableResultData
+        @see com::sun::star::sheet::DataPiotTableHeaderData
+     */
+    any     PositionData;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif
+