office-gobmx/udkapi/com/sun/star/lang/ServiceManager.idl
Rüdiger Timm 3b5f2d7447 INTEGRATION: CWS ooo19126 (1.14.42); FILE MERGED
2005/09/05 14:07:13 rt 1.14.42.1: #i54170# Change license header: remove SISSL
2005-09-09 14:45:27 +00:00

149 lines
5.1 KiB
Text

/*************************************************************************
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: ServiceManager.idl,v $
*
* $Revision: 1.15 $
*
* last change: $Author: rt $ $Date: 2005-09-09 15:45:27 $
*
* The Contents of this file are made available subject to
* the terms of GNU Lesser General Public License Version 2.1.
*
*
* GNU Lesser General Public License Version 2.1
* =============================================
* Copyright 2005 by Sun Microsystems, Inc.
* 901 San Antonio Road, Palo Alto, CA 94303, USA
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License version 2.1, as published by the Free Software Foundation.
*
* This library 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 for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston,
* MA 02111-1307 USA
*
************************************************************************/
#ifndef __com_sun_star_lang_ServiceManager_idl__
#define __com_sun_star_lang_ServiceManager_idl__
#ifndef __com_sun_star_lang_MultiServiceFactory_idl__
#include <com/sun/star/lang/MultiServiceFactory.idl>
#endif
#ifndef __com_sun_star_lang_XComponent_idl__
#include <com/sun/star/lang/XComponent.idl>
#endif
#ifndef __com_sun_star_container_XSet_idl__
#include <com/sun/star/container/XSet.idl>
#endif
#ifndef __com_sun_star_container_XContentEnumerationAccess_idl__
#include <com/sun/star/container/XContentEnumerationAccess.idl>
#endif
#ifndef __com_sun_star_lang_XMultiServiceFactory_idl__
#include <com/sun/star/lang/XMultiServiceFactory.idl>
#endif
#ifndef __com_sun_star_lang_XMultiComponentFactory_idl__
#include <com/sun/star/lang/XMultiComponentFactory.idl>
#endif
#ifndef __com_sun_star_lang_XServiceInfo_idl__
#include <com/sun/star/lang/XServiceInfo.idl>
#endif
#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif
//=============================================================================
module com { module sun { module star { module lang {
//=============================================================================
/** Provides a collection of implementations for services. This is a singleton
you commonly find in your component context under key
<code>/singletons/com.sun.star.lang.theServiceManager</code>.
<p>
The factories are accessed with a service name. It is possible to
access the factories with their implementation names, but you should
avoid this.
</p>
<p>Service factories added via <type scope="com::sun::star::container">XSet</type>
should support the following interfaces: </p>
<dl>
<dt><type>XServiceInfo</type></dt>
<dd>supported interfaces/ implementation name</dd>
<dt><type>XSingleComponentFactory</type>(optional)</dt>
<dd>is used to create instances of the implementation.</dd>
<dt><type>XComponent</type> (optional)</dt>
<dd>The service manager calls the method
<member scope="com::sun::star::lang">XComponent::dispose</member>
on the factory when going down (i.e. it is commonly disposed by the component context).</dd>
</dl>
@see com::sun::star::uno::XComponentContext
*/
published service ServiceManager
{
/** This is a derived MultiServiceFactory service.
*/
service com::sun::star::lang::MultiServiceFactory;
/** Disposing of service manager.
<p>
The component context disposes its service manager singleton when going down
(i.e. when the component context is disposed).
</p>
*/
interface com::sun::star::lang::XComponent;
/** Management of service factories.
*/
interface com::sun::star::container::XSet;
/** Enumeration of all service factories.
<p>
It is possible to enumerate all implementations that support the
service specified with the argument of the
<member scope="com::sun::star::container">XContentEnumerationAccess::createContentEnumeration</member> method.
The enumerator commonly returns <type>XSingleComponentFactory</type>
interfaces.
</p>
*/
interface com::sun::star::container::XContentEnumerationAccess;
/** Property access.
*/
[optional] interface com::sun::star::beans::XPropertySet;
/** specifies the default component context to be used, if instanciating services
via <type>XMultiServiceFactory</type>
*/
[optional, property] com::sun::star::uno::XComponentContext DefaultContext;
};
//=============================================================================
}; }; }; };
/*=============================================================================
=============================================================================*/
#endif