1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_container_XContentEnumerationAccess_idl__
24#define __com_sun_star_container_XContentEnumerationAccess_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_container_XEnumeration_idl__
31#include <com/sun/star/container/XEnumeration.idl>
32#endif
33
34
35//=============================================================================
36
37module com {  module sun {  module star {  module container {
38
39//=============================================================================
40
41/** allows access to the collections of all content types within the object.
42
43	@example
44		<p>This example prints the names of all tables: </p>
45
46	<listing>
47		xTextTableEnum = xTextDoc.createContentEnumeration( "com::sun::star::text::TextTable" )
48		while xTextTableEnum.hasMoreElements() do
49			print xTextTableEnum.nextElement().Name
50		wend
51	</listing>
52 */
53published interface XContentEnumerationAccess: com::sun::star::uno::XInterface
54{
55	//-------------------------------------------------------------------------
56
57	/** @returns
58			a new enumeration object for the contents of the specified service type.
59	 */
60	com::sun::star::container::XEnumeration createContentEnumeration( [in] string aServiceName );
61
62	//-------------------------------------------------------------------------
63
64	// DocMerge from idl: method com::sun::star::container::XContentEnumerationAccess::getAvailableServiceNames
65	/** @returns
66				all names of services of which instances exist in this object.
67
68		<p><member>XContentEnumerationAccess::createContentEnumeration</member>
69        creates an enumeration for all the service names which are
70        listed here. For all others it creates no enumeration. </p>
71	 */
72	sequence<string> getAvailableServiceNames();
73
74};
75
76//=============================================================================
77
78}; }; }; };
79
80#endif
81