/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XContentEnumerationAccess.idl,v $
 *
 *  $Revision: 1.11 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-09 15:14:02 $
 *
 *  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_XContentEnumerationAccess_idl__
#define __com_sun_star_container_XContentEnumerationAccess_idl__

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

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


//=============================================================================

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 a non-empty enumeration for all the service names which are
        listed here. For all others it creates no enumeration. </p>
     */
    sequence<string> getAvailableServiceNames();

};

//=============================================================================

}; }; }; };

#endif
