/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: XLinguServiceEventBroadcaster.idl,v $
 *
 *  $Revision: 1.10 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 02:11:57 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#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

