blob: 7c82659eb2cc11a8961779bc81bf80883fbecdbd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
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: */
|
