From db3078bd8c8e3ce3a99fc3987bb6e93b609990c1 Mon Sep 17 00:00:00 2001
From: Samuel Mehrbrodt <samuel.mehrbrodt@allotropia.de>
Date: Thu, 21 Sep 2023 16:00:40 +0200
Subject: tdf#157431 Show description for expert config items

Change-Id: I7d0257c2e06ed384f90ca3b51a6d2549044f2cf3
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/157148
Tested-by: Jenkins
Reviewed-by: Samuel Mehrbrodt <samuel.mehrbrodt@allotropia.de>
---
 offapi/UnoApi_offapi.mk                            |  1 +
 .../com/sun/star/configuration/XDocumentation.idl  | 34 ++++++++++++++++++++++
 2 files changed, 35 insertions(+)
 create mode 100644 offapi/com/sun/star/configuration/XDocumentation.idl

(limited to 'offapi')

diff --git a/offapi/UnoApi_offapi.mk b/offapi/UnoApi_offapi.mk
index eba803973aa5..2e2ee40aa8b4 100644
--- a/offapi/UnoApi_offapi.mk
+++ b/offapi/UnoApi_offapi.mk
@@ -2083,6 +2083,7 @@ $(eval $(call gb_UnoApi_add_idlfiles,offapi,com/sun/star/configuration,\
 	InstallationIncompleteException \
 	InvalidBootstrapFileException \
 	MissingBootstrapFileException \
+    XDocumentation \
     XReadWriteAccess \
 	XTemplateContainer \
 	XTemplateInstance \
diff --git a/offapi/com/sun/star/configuration/XDocumentation.idl b/offapi/com/sun/star/configuration/XDocumentation.idl
new file mode 100644
index 000000000000..3bf3c638b141
--- /dev/null
+++ b/offapi/com/sun/star/configuration/XDocumentation.idl
@@ -0,0 +1,34 @@
+/* -*- 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/.
+ */
+
+module com { module sun { module star { module configuration {
+
+/* Is used to deliver documentation for the configuration.
+
+   <p>This interface is still unpublished and unstable.</p>
+
+   @since LibreOffice 24.2
+*/
+interface XDocumentation {
+    /** @returns
+            the description for the requested object
+
+        @param aName
+            the hierarchical name of the object.
+
+        @throws NoSuchElementException
+            if an element under aName does not exist.
+     */
+    string getDescriptionByHierarchicalName( [in] string aName )
+            raises( com::sun::star::container::NoSuchElementException );
+};
+
+}; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
-- 
cgit