diff options
Diffstat (limited to 'udkapi/com/sun/star/container/XContentEnumerationAccess.idl')
-rw-r--r-- | udkapi/com/sun/star/container/XContentEnumerationAccess.idl | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/container/XContentEnumerationAccess.idl b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl new file mode 100644 index 000000000000..37f2bc34b372 --- /dev/null +++ b/udkapi/com/sun/star/container/XContentEnumerationAccess.idl @@ -0,0 +1,84 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * 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_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 an enumeration for all the service names which are + listed here. For all others it creates no enumeration. </p> + */ + sequence<string> getAvailableServiceNames(); + +}; + +//============================================================================= + +}; }; }; }; + +#endif |