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

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