summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/sheet/FunctionDescriptions.idl
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--offapi/com/sun/star/sheet/FunctionDescriptions.idl71
1 files changed, 71 insertions, 0 deletions
diff --git a/offapi/com/sun/star/sheet/FunctionDescriptions.idl b/offapi/com/sun/star/sheet/FunctionDescriptions.idl
new file mode 100644
index 000000000..69361753d
--- /dev/null
+++ b/offapi/com/sun/star/sheet/FunctionDescriptions.idl
@@ -0,0 +1,71 @@
+/* -*- 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_FunctionDescriptions_idl__
+#define __com_sun_star_sheet_FunctionDescriptions_idl__
+
+#include <com/sun/star/sheet/XFunctionDescriptions.idl>
+#include <com/sun/star/container/XNameAccess.idl>
+#include <com/sun/star/container/XEnumerationAccess.idl>
+
+
+module com { module sun { module star { module sheet {
+
+
+/** represents a collection of function descriptions for all built-in
+ functions as well as add-in functions available in the spreadsheet
+ application.
+
+ <p>All container access methods return a sequence of
+ com::sun::star::beans::PropertyValue structs.
+ The properties contained in the sequence are collected in the
+ service FunctionDescription.</p>
+ */
+published service FunctionDescriptions
+{
+
+ /** provides access to the property sequence of a function description
+ via function index or identifier.
+ */
+ interface com::sun::star::sheet::XFunctionDescriptions;
+
+
+ /** provides access to the property sequence of a function description
+ via function name.
+
+ <p>The localized uppercase name of the function has to be used
+ here.</p>
+ */
+ interface com::sun::star::container::XNameAccess;
+
+
+ /** creates an enumeration of all function descriptions.
+
+ @see com::sun::star::sheet::FunctionDescriptionEnumeration
+ */
+ interface com::sun::star::container::XEnumerationAccess;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */