offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.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: XLinguServiceEventBroadcaster.idl,v $
  10  * $Revision: 1.11 $
  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_linguistic2_XLinguServiceEventBroadcaster_idl__
  31 #define __com_sun_star_linguistic2_XLinguServiceEventBroadcaster_idl__
  32
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_linguistic2_XLinguServiceEventListener_idl__
  39 #include <com/sun/star/linguistic2/XLinguServiceEventListener.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com { module sun { module star { module linguistic2 {
  45
  46 //=============================================================================
  47 /** is used to register a listener for LinguServiceEvents.
  48
  49     <P>This interface may be used by spellchecker or hyphenator
  50     implementations to allow clients to be registered and informed about
  51     <type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s.
  52     </P>
  53
  54     <P>Note: The LinguServiceManager forwards the
  55     <type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s
  56     it receives (from spellcheckers or hyphenators) to its own listeners.
  57     Thus, there should be no need to register
  58     as a listener for a specific implementation./P>
  59
  60     @see    <type scope="com::sun::star::linguistic2">XLinguServiceManager</type>
  61     @see    <type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type>
  62 */
  63 published interface XLinguServiceEventBroadcaster : com::sun::star::uno::XInterface
  64 {
  65     //-------------------------------------------------------------------------
  66     /**
  67          @returns
  68              <TRUE/> if the listener was successfully added,
  69             <FALSE/> otherwise.
  70
  71         @param xLstnr
  72             the listener to be addded.
  73      */
  74     boolean     addLinguServiceEventListener (
  75         [in] com::sun::star::linguistic2::XLinguServiceEventListener    xLstnr );
  76
  77     //-------------------------------------------------------------------------
  78     /**
  79          @returns
  80              <TRUE/> if the listener was successfully removed,
  81             <FALSE/> otherwise.
  82
  83         @param xLstnr
  84             the listener to be removed.
  85      */
  86     boolean     removeLinguServiceEventListener (
  87         [in] com::sun::star::linguistic2::XLinguServiceEventListener    xLstnr );
  88
  89 };
  90
  91 //=============================================================================
  92
  93 }; }; }; };
  94
  95 #endif
  96