xref: /trunk/main/offapi/com/sun/star/ucb/XSourceInitialization.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_XSourceInitialization_idl__
#define __com_sun_star_ucb_XSourceInitialization_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_ucb_AlreadyInitializedException_idl__
#include <com/sun/star/ucb/AlreadyInitializedException.idl>
#endif

//=============================================================================

module com { module sun { module star { module ucb {

//=============================================================================
/** provides the initialization of a component with any source object.
*/

published interface XSourceInitialization: com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/**	provides the initialization of a component with any source object.

		<p>The service description has to specify which type of interface must
		be set as parameter.

		<p>Hopefully you will only use this, when <var>Source</var>
		is an <type scope="com::sun::star::lang">XComponent</type> and this
		is an <type scope="com::sun::star::lang">XEventListener</type>.
		Than you should call
		<member scope="com::sun::star::lang">XComponent::addEventListener()</member>
		from inside the implementation of this method.

		@param Source
		the source.

		@throws AlreadyInitializedException
		if this method is called more than once during the lifetime of the
		object implementing this interface.

	*/
	void setSource(	[in] com::sun::star::uno::XInterface Source )
		 raises (AlreadyInitializedException);
};

//=============================================================================

}; }; }; };

#endif