summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/form/XGridFieldDataSupplier.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/form/XGridFieldDataSupplier.idl')
-rw-r--r--offapi/com/sun/star/form/XGridFieldDataSupplier.idl79
1 files changed, 79 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/XGridFieldDataSupplier.idl b/offapi/com/sun/star/form/XGridFieldDataSupplier.idl
new file mode 100644
index 000000000..7a26b1a13
--- /dev/null
+++ b/offapi/com/sun/star/form/XGridFieldDataSupplier.idl
@@ -0,0 +1,79 @@
+/* -*- 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_form_XGridFieldDataSupplier_idl__
+#define __com_sun_star_form_XGridFieldDataSupplier_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/reflection/XIdlClass.idl>
+
+
+
+ module com { module sun { module star { module form {
+
+
+/** provides access to the data of a GridControl
+
+ <p>You can retrieve the data type information and the data in a row.</p>
+
+ <p>This interface allows to retrieve data even for rows which are not current, which is quite useful,
+ as normally, you can't affect the current row in a grid control without moving the cursor of the underlying
+ com::sun::star::form::component::DataForm.</p>
+
+ @see XGrid
+ @see com::sun::star::form::control::GridControl
+ @see com::sun::star::form::component::GridControl
+
+ @deprecated
+ */
+published interface XGridFieldDataSupplier: com::sun::star::uno::XInterface
+{
+ /** checks whether or not the content of the grid's columns can be retrieved in the requested format.
+
+ <p>Not every cell content can be retrieved in every representation. For example, in a text column,
+ you usually won't be able to retrieve the content as double.<br/>
+ To check if the type you need is supported by the columns, use this method.</p>
+
+ @return
+ A sequence of boolean flags. Each flag corresponds to the respective column, and `TRUE` indicates
+ that the column content can be retrieved in the requested format, `FALSE` denies this.
+
+ @see XGridColumnFactory
+ @see DataAwareControlModel
+ @see XGridFieldDataSupplier::queryFieldData
+ */
+ sequence<boolean> queryFieldDataType( [in] type xType );
+
+ /** retrieves the actual column data for the given row
+
+ <p>If a column does not support the requested type, `NULL` is returned at the respective
+ position.</p>
+
+ @see XGridFieldDataSupplier::queryFieldDataType
+ */
+ sequence<any> queryFieldData( [in] long nRow,
+ [in] type xType );
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */