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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_container_XContentEnumerationAccess_idl__
  20 #define __com_sun_star_container_XContentEnumerationAccess_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/container/XEnumeration.idl>
  25
  26
  27
  28 module com {  module sun {  module star {  module container {
  29
  30
  31 /** allows access to the collections of all content types within the object.
  32
  33     <p>This example prints the names of all tables: </p>
  34
  35     @code{.bas}
  36         xTextTableEnum = xTextDoc.createContentEnumeration( "com::sun::star::text::TextTable" )
  37         while xTextTableEnum.hasMoreElements() do
  38             print xTextTableEnum.nextElement().Name
  39         wend
  40     @endcode
  41  */
  42 published interface XContentEnumerationAccess: com::sun::star::uno::XInterface
  43 {
  44
  45     /** @returns
  46             a new enumeration object for the contents of the specified service type.
  47      */
  48     com::sun::star::container::XEnumeration createContentEnumeration( [in] string aServiceName );
  49
  50     /** @returns
  51                 all names of services of which instances exist in this object.
  52
  53         <p>XContentEnumerationAccess::createContentEnumeration()
  54         creates an enumeration for all the service names which are
  55         listed here. For all others it creates no enumeration. </p>
  56      */
  57     sequence<string> getAvailableServiceNames();
  58
  59 };
  60
  61
  62 }; }; }; };
  63
  64 #endif
  65
  66 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */