blob: d8d753d439abde4492aa0affeb909e78dba7a539 (
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XNameAccess.idl,v $
* $Revision: 1.13 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_container_XNameAccess_idl__
#define __com_sun_star_container_XNameAccess_idl__
#ifndef __com_sun_star_container_XElementAccess_idl__
#include <com/sun/star/container/XElementAccess.idl>
#endif
#ifndef __com_sun_star_container_NoSuchElementException_idl__
#include <com/sun/star/container/NoSuchElementException.idl>
#endif
#ifndef __com_sun_star_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif
//=============================================================================
module com { module sun { module star { module container {
//=============================================================================
/** is used to access named objects within a container.
<p>To implement inaccurate name access, support the
<type scope="com::sun::star::beans">XExactName</type>
interface. </p>
@see com::sun::star::beans::XExactName
*/
published interface XNameAccess: com::sun::star::container::XElementAccess
{
//-------------------------------------------------------------------------
/** @returns
the object with the specified name.
@param aName
the name of the object.
@throws NoSuchElementException
if an element under Name does not exist.
@throws com::sun::star::lang::WrappedTargetException
If the implementation has internal reasons for exceptions,
then wrap these in a <type scope="com::sun::star::lang">WrappedTargetException</type>
exception.
*/
any getByName( [in] string aName )
raises( com::sun::star::container::NoSuchElementException,
com::sun::star::lang::WrappedTargetException );
//-------------------------------------------------------------------------
/** @returns
a sequence of all element names in this container.
<p>The order of the names is not specified. </p>
*/
sequence<string> getElementNames();
//-------------------------------------------------------------------------
/** @returns
<TRUE/> if an element with this name is in
the container, <FALSE/> otherwise.
<p>In many cases the next call is <member>XNameAccess::getByName</member>.
You should optimize this case. </p>
@param aName
the name of the object.
*/
boolean hasByName( [in] string aName );
};
//=============================================================================
}; }; }; };
#endif
|
