udkapi/com/sun/star/container/XContentEnumerationAccess.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XContentEnumerationAccess.idl,v $
  10  * $Revision: 1.13 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_container_XContentEnumerationAccess_idl__
  31 #define __com_sun_star_container_XContentEnumerationAccess_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XEnumeration_idl__
  38 #include <com/sun/star/container/XEnumeration.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module container {
  45
  46 //=============================================================================
  47
  48 /** allows access to the collections of all content types within the object.
  49
  50     @example
  51         <p>This example prints the names of all tables: </p>
  52
  53     <listing>
  54         xTextTableEnum = xTextDoc.createContentEnumeration( "com::sun::star::text::TextTable" )
  55         while xTextTableEnum.hasMoreElements() do
  56             print xTextTableEnum.nextElement().Name
  57         wend
  58     </listing>
  59  */
  60 published interface XContentEnumerationAccess: com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63
  64     /** @returns
  65             a new enumeration object for the contents of the specified service type.
  66      */
  67     com::sun::star::container::XEnumeration createContentEnumeration( [in] string aServiceName );
  68
  69     //-------------------------------------------------------------------------
  70
  71     // DocMerge from idl: method com::sun::star::container::XContentEnumerationAccess::getAvailableServiceNames
  72     /** @returns
  73                 all names of services of which instances exist in this object.
  74
  75         <p><member>XContentEnumerationAccess::createContentEnumeration</member>
  76         creates an enumeration for all the service names which are
  77         listed here. For all others it creates no enumeration. </p>
  78      */
  79     sequence<string> getAvailableServiceNames();
  80
  81 };
  82
  83 //=============================================================================
  84
  85 }; }; }; };
  86
  87 #endif