LibreOffice LibreOffice 25.2 SDK API Reference

XDocumentation.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 */
9
10module com { module sun { module star { module configuration {
11
12/* Is used to deliver documentation for the configuration.
13
14 <p>This interface is still unpublished and unstable.</p>
15
16 @since LibreOffice 24.2
17*/
18 interface XDocumentation {
28 string getDescriptionByHierarchicalName( [in] string aName )
29 raises( com::sun::star::container::NoSuchElementException );
30
43 type getTypeByHierarchicalName( [in] string aName )
44 raises( com::sun::star::container::NoSuchElementException,
45 com::sun::star::util::InvalidStateException );
46
59 boolean getModifiedByHierarchicalName( [in] string aName )
60 raises( com::sun::star::container::NoSuchElementException,
61 com::sun::star::util::InvalidStateException );
62};
63
64}; }; }; };
65
66/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:31
com::sun::star::util::InvalidStateException
is thrown when an object's state does not allow to call requested functionality.
Definition: InvalidStateException.idl:27
com::sun::star::configuration::XDocumentation
Definition: XDocumentation.idl:18
com::sun::star::configuration::XDocumentation::getDescriptionByHierarchicalName
string getDescriptionByHierarchicalName([in] string aName)
com::sun::star::configuration::XDocumentation::getTypeByHierarchicalName
type getTypeByHierarchicalName([in] string aName)
com::sun::star::configuration::XDocumentation::getModifiedByHierarchicalName
boolean getModifiedByHierarchicalName([in] string aName)
com
Definition: Ambiguous.idl:20