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
110
|
/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: XEnumeration.idl,v $
*
* $Revision: 1.11 $
*
* last change: $Author: rt $ $Date: 2005-09-09 15:14:32 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef __com_sun_star_container_XEnumeration_idl__
#define __com_sun_star_container_XEnumeration_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.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 {
//=============================================================================
/** provides functionality to enumerate the contents of a container.
<p>An object that implements the <type>XEnumeration</type> interface
generates a series of elements, one at a time. Successive calls to
the <code>XEnumeration::nextElement</code> method return successive
elements of the series. </p>
<p>For example (Java), to print all elements of a vector <var>aVect</var>:
</p>
<listing>
for ( XEnumeration xEnum = aVect.elements() ;
xEnum.hasMoreElements() ; )
{
System.out.println( xEnum.nextElement() );
}
</listing>
<p> If the object changed, the behavior of the enumeration is
not specified. This is not a remote interface. </p>
*/
published interface XEnumeration: com::sun::star::uno::XInterface
{
//-------------------------------------------------------------------------
/** tests whether this enumeration contains more elements.
*/
boolean hasMoreElements();
//-------------------------------------------------------------------------
/** @returns
the next element of this enumeration.
@throws NoSuchElementException
if no more elements 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 nextElement()
raises( com::sun::star::container::NoSuchElementException,
com::sun::star::lang::WrappedTargetException );
};
//=============================================================================
}; }; }; };
#endif
|
