summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/report/meta/XFunctionDescription.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/report/meta/XFunctionDescription.idl')
-rw-r--r--offapi/com/sun/star/report/meta/XFunctionDescription.idl73
1 files changed, 73 insertions, 0 deletions
diff --git a/offapi/com/sun/star/report/meta/XFunctionDescription.idl b/offapi/com/sun/star/report/meta/XFunctionDescription.idl
new file mode 100644
index 000000000..30b2f89f7
--- /dev/null
+++ b/offapi/com/sun/star/report/meta/XFunctionDescription.idl
@@ -0,0 +1,73 @@
+/* -*- 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_report_meta_XFunctionDescription_idl__
+#define __com_sun_star_report_meta_XFunctionDescription_idl__
+
+#include <com/sun/star/lang/DisposedException.idl>
+#include <com/sun/star/lang/IllegalArgumentException.idl>
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/sheet/FunctionArgument.idl>
+module com { module sun { module star { module report { module meta {
+
+interface XFunctionCategory;
+
+/** identifies a XFunctionDescription which allows to retrieve the meta data of all supported functions.
+
+*/
+interface XFunctionDescription
+{
+ /** gives access to the properties.
+ */
+ interface com::sun::star::beans::XPropertySet;
+
+ string createFormula([in] sequence< string > arguments )
+ raises( ::com::sun::star::lang::DisposedException,
+ com::sun::star::lang::IllegalArgumentException,
+ ::com::sun::star::uno::Exception );
+
+ /** specifies the category number.
+ */
+ [attribute,readonly] XFunctionCategory Category;
+
+ /** returns the localized function's name.
+ */
+ [attribute,readonly] string Name;
+
+
+ /** returns a localized description of the function.
+ */
+ [attribute,readonly] string Description;
+
+ /** returns the signature of the function.
+ */
+ [attribute,readonly] string Signature;
+
+
+ /** returns a sequence of localized descriptions of the function's
+ arguments (in the order specified by the function).
+ */
+ [attribute,readonly] sequence< com::sun::star::sheet::FunctionArgument > Arguments;
+};
+
+
+}; }; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */