xref: /AOO41X/main/offapi/com/sun/star/ucb/XSourceInitialization.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_XSourceInitialization_idl__
24#define __com_sun_star_ucb_XSourceInitialization_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30#ifndef __com_sun_star_ucb_AlreadyInitializedException_idl__
31#include <com/sun/star/ucb/AlreadyInitializedException.idl>
32#endif
33
34//=============================================================================
35
36module com { module sun { module star { module ucb {
37
38//=============================================================================
39/** provides the initialization of a component with any source object.
40*/
41
42published interface XSourceInitialization: com::sun::star::uno::XInterface
43{
44    //-------------------------------------------------------------------------
45    /** provides the initialization of a component with any source object.
46
47        <p>The service description has to specify which type of interface must
48        be set as parameter.
49
50        <p>Hopefully you will only use this, when <var>Source</var>
51        is an <type scope="com::sun::star::lang">XComponent</type> and this
52        is an <type scope="com::sun::star::lang">XEventListener</type>.
53        Than you should call
54        <member scope="com::sun::star::lang">XComponent::addEventListener()</member>
55        from inside the implementation of this method.
56
57        @param Source
58        the source.
59
60        @throws AlreadyInitializedException
61        if this method is called more than once during the lifetime of the
62        object implementing this interface.
63
64    */
65    void setSource( [in] com::sun::star::uno::XInterface Source )
66         raises (AlreadyInitializedException);
67};
68
69//=============================================================================
70
71}; }; }; };
72
73#endif
74