summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/container/XContentEnumerationAccess.idl
blob: a64c6688be1a5c3a61542b79f167bb42dc1997cc (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
/* -*- 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/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_container_XContentEnumerationAccess_idl__
#define __com_sun_star_container_XContentEnumerationAccess_idl__

#include <com/sun/star/uno/XInterface.idl>

#include <com/sun/star/container/XEnumeration.idl>



module com {  module sun {  module star {  module container {


/** allows access to the collections of all content types within the object.

    @example
        <p>This example prints the names of all tables: </p>

    <listing>
        xTextTableEnum = xTextDoc.createContentEnumeration( "com::sun::star::text::TextTable" )
        while xTextTableEnum.hasMoreElements() do
            print xTextTableEnum.nextElement().Name
        wend
    </listing>
 */
published interface XContentEnumerationAccess: com::sun::star::uno::XInterface
{

    /** @returns
            a new enumeration object for the contents of the specified service type.
     */
    com::sun::star::container::XEnumeration createContentEnumeration( [in] string aServiceName );


    // DocMerge from idl: method com::sun::star::container::XContentEnumerationAccess::getAvailableServiceNames
    /** @returns
                all names of services of which instances exist in this object.

        <p><member>XContentEnumerationAccess::createContentEnumeration</member>
        creates an enumeration for all the service names which are
        listed here. For all others it creates no enumeration. </p>
     */
    sequence<string> getAvailableServiceNames();

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */