udkapi/com/sun/star/lang/ServiceManager.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_lang_ServiceManager_idl__
  20 #define __com_sun_star_lang_ServiceManager_idl__
  21
  22 #include <com/sun/star/lang/MultiServiceFactory.idl>
  23
  24 #include <com/sun/star/lang/XComponent.idl>
  25
  26 #include <com/sun/star/container/XSet.idl>
  27
  28 #include <com/sun/star/container/XContentEnumerationAccess.idl>
  29
  30 #include <com/sun/star/lang/XMultiServiceFactory.idl>
  31 #include <com/sun/star/lang/XMultiComponentFactory.idl>
  32
  33 #include <com/sun/star/lang/XServiceInfo.idl>
  34
  35 #include <com/sun/star/beans/XPropertySet.idl>
  36
  37
  38 module com {  module sun {  module star {  module lang {
  39
  40
  41 /** Provides a collection of implementations for services.  This is a singleton
  42     you commonly find in your component context under key
  43     <code>/singletons/com.sun.star.lang.theServiceManager</code>.
  44
  45     <p>
  46     The factories are accessed with a service name. It is possible to
  47     access the factories with their implementation names, but you should
  48     avoid this.
  49     </p>
  50
  51     <p>Service factories added via com::sun::star::container::XSet
  52     should support the following interfaces: </p>
  53
  54     <dl>
  55     <dt>XServiceInfo</dt>
  56     <dd>supported interfaces/ implementation name</dd>
  57
  58     <dt>XSingleComponentFactory(optional)</dt>
  59     <dd>is used to create instances of the implementation.</dd>
  60
  61     <dt>XComponent (optional)</dt>
  62     <dd>The service manager calls the method
  63     com::sun::star::lang::XComponent::dispose()
  64     on the factory when going down (i.e. it is commonly disposed by the component context).</dd>
  65     </dl>
  66
  67     <p>Since LibreOffice 3.6, in addition to instances of
  68     XServiceInfo et al, the
  69     com::sun::star::container::XSet of at least the default
  70     C++ service manager implementation now also supports sequences of
  71     com::sun::star::beans::NamedValue in <code>insert</code>
  72     and <code>remove</code>.  The sequence elements must each have a
  73     <code>Name</code> of <code>uri</code> and a string <code>Value</code> that
  74     is the URI of a service rdb.  It is legal for there to be no such
  75     <code>uri</code> elements.  For <code>insert</code>, there can additionally
  76     be an optional element with a <code>Name</code> of
  77     <code>component-context</code> and a value that is a non-null reference of
  78     type com::sun::star::uno::XComponentContext that shall
  79     be used instead of this service manager's default component context when
  80     loading the corresponding implementations.
  81
  82     @see com::sun::star::uno::XComponentContext
  83 */
  84 published service ServiceManager
  85 {
  86     /** This is a derived MultiServiceFactory service.
  87     */
  88     service com::sun::star::lang::MultiServiceFactory;
  89
  90     /** Disposing of service manager.
  91         <p>
  92         The component context disposes its service manager singleton when going down
  93         (i.e. when the component context is disposed).
  94         </p>
  95     */
  96     interface com::sun::star::lang::XComponent;
  97
  98     /** Management of service factories.
  99     */
 100     interface com::sun::star::container::XSet;
 101
 102     /** Enumeration of all service factories.
 103         <p>
 104         It is possible to enumerate all implementations that support the
 105         service specified with the argument of the
 106         com::sun::star::container::XContentEnumerationAccess::createContentEnumeration() method.
 107         The enumerator commonly returns XSingleComponentFactory
 108         interfaces.
 109         </p>
 110     */
 111     interface com::sun::star::container::XContentEnumerationAccess;
 112
 113     /** Property access.
 114     */
 115     [optional] interface com::sun::star::beans::XPropertySet;
 116     /** specifies the default component context to be used, if instanciating services
 117         via XMultiServiceFactory
 118     */
 119     [optional, property] com::sun::star::uno::XComponentContext DefaultContext;
 120 };
 121
 122
 123 }; }; }; };
 124
 125 #endif
 126
 127 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */