summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/configuration/XDocumentation.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/configuration/XDocumentation.idl')
-rw-r--r--offapi/com/sun/star/configuration/XDocumentation.idl66
1 files changed, 66 insertions, 0 deletions
diff --git a/offapi/com/sun/star/configuration/XDocumentation.idl b/offapi/com/sun/star/configuration/XDocumentation.idl
new file mode 100644
index 0000000000..7c82659eb2
--- /dev/null
+++ b/offapi/com/sun/star/configuration/XDocumentation.idl
@@ -0,0 +1,66 @@
+/* -*- 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 );
+
+ /** @returns
+ the type for the requested object
+
+ @param aName
+ the hierarchical name of the object.
+
+ @throws NoSuchElementException
+ if an element under aName does not exist.
+
+ @throws InvalidStateException
+ when the type of the object could not be resolved.
+ */
+ type getTypeByHierarchicalName( [in] string aName )
+ raises( com::sun::star::container::NoSuchElementException,
+ com::sun::star::util::InvalidStateException );
+
+ /** @returns
+ whether the requested object was modified
+
+ @param aName
+ the hierarchical name of the object.
+
+ @throws NoSuchElementException
+ if an element under aName does not exist.
+
+ @throws InvalidStateException
+ when the object has an invalid type
+ */
+ boolean getModifiedByHierarchicalName( [in] string aName )
+ raises( com::sun::star::container::NoSuchElementException,
+ com::sun::star::util::InvalidStateException );
+};
+
+}; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */