offapi/com/sun/star/ucb/XSourceInitialization.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_ucb_XSourceInitialization_idl__
  28 #define __com_sun_star_ucb_XSourceInitialization_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_ucb_AlreadyInitializedException_idl__
  35 #include <com/sun/star/ucb/AlreadyInitializedException.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module ucb {
  41
  42 //=============================================================================
  43 /** provides the initialization of a component with any source object.
  44 */
  45
  46 published interface XSourceInitialization: com::sun::star::uno::XInterface
  47 {
  48     //-------------------------------------------------------------------------
  49     /** provides the initialization of a component with any source object.
  50
  51         <p>The service description has to specify which type of interface must
  52         be set as parameter.
  53
  54         <p>Hopefully you will only use this, when <var>Source</var>
  55         is an <type scope="com::sun::star::lang">XComponent</type> and this
  56         is an <type scope="com::sun::star::lang">XEventListener</type>.
  57         Than you should call
  58         <member scope="com::sun::star::lang">XComponent::addEventListener()</member>
  59         from inside the implementation of this method.
  60
  61         @param Source
  62         the source.
  63
  64         @throws AlreadyInitializedException
  65         if this method is called more than once during the lifetime of the
  66         object implementing this interface.
  67
  68     */
  69     void setSource( [in] com::sun::star::uno::XInterface Source )
  70          raises (AlreadyInitializedException);
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76
  77 #endif