offapi/com/sun/star/ucb/XSourceInitialization.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XSourceInitialization.idl,v $
  10  * $Revision: 1.9 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_XSourceInitialization_idl__
  31 #define __com_sun_star_ucb_XSourceInitialization_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_AlreadyInitializedException_idl__
  38 #include <com/sun/star/ucb/AlreadyInitializedException.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module ucb {
  44
  45 //=============================================================================
  46 /** provides the initialization of a component with any source object.
  47 */
  48
  49 published interface XSourceInitialization: com::sun::star::uno::XInterface
  50 {
  51     //-------------------------------------------------------------------------
  52     /** provides the initialization of a component with any source object.
  53
  54         <p>The service description has to specify which type of interface must
  55         be set as parameter.
  56
  57         <p>Hopefully you will only use this, when <var>Source</var>
  58         is an <type scope="com::sun::star::lang">XComponent</type> and this
  59         is an <type scope="com::sun::star::lang">XEventListener</type>.
  60         Than you should call
  61         <member scope="com::sun::star::lang">XComponent::addEventListener()</member>
  62         from inside the implementation of this method.
  63
  64         @param Source
  65         the source.
  66
  67         @throws AlreadyInitializedException
  68         if this method is called more than once during the lifetime of the
  69         object implementing this interface.
  70
  71     */
  72     void setSource(     [in] com::sun::star::uno::XInterface Source )
  73          raises (AlreadyInitializedException);
  74 };
  75
  76 //=============================================================================
  77
  78 }; }; }; };
  79
  80 #endif