xref: /aoo41x/main/offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.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_linguistic2_XLinguServiceEventBroadcaster_idl__
#define __com_sun_star_linguistic2_XLinguServiceEventBroadcaster_idl__


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

#ifndef __com_sun_star_linguistic2_XLinguServiceEventListener_idl__
#include <com/sun/star/linguistic2/XLinguServiceEventListener.idl>
#endif

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

module com { module sun { module star { module linguistic2 {

//=============================================================================
/** is used to register a listener for LinguServiceEvents.

	<P>This interface may be used by spellchecker or hyphenator
	implementations to allow clients to be registered and informed about
	<type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s.
	</P>

	<P>Note: The LinguServiceManager forwards the
	<type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s
	it receives (from spellcheckers or hyphenators) to its own listeners.
	Thus, there should be no need to register
	as a listener for a specific implementation./P>

    @see    <type scope="com::sun::star::linguistic2">XLinguServiceManager</type>
    @see    <type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type>
*/
published interface XLinguServiceEventBroadcaster : com::sun::star::uno::XInterface
{
	//-------------------------------------------------------------------------
	/**
	 	@returns
		 	<TRUE/> if the listener was successfully added,
			<FALSE/> otherwise.

		@param xLstnr
			the listener to be addded.
	 */
	boolean	addLinguServiceEventListener (
		[in] com::sun::star::linguistic2::XLinguServiceEventListener	xLstnr );

	//-------------------------------------------------------------------------
	/**
	 	@returns
		 	<TRUE/> if the listener was successfully removed,
			<FALSE/> otherwise.

		@param xLstnr
			the listener to be removed.
	 */
	boolean	removeLinguServiceEventListener (
		[in] com::sun::star::linguistic2::XLinguServiceEventListener	xLstnr );

};

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

}; }; }; };

#endif