offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_linguistic2_XLinguServiceEventBroadcaster_idl__
  28 #define __com_sun_star_linguistic2_XLinguServiceEventBroadcaster_idl__
  29
  30
  31 #ifndef __com_sun_star_uno_XInterface_idl__
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_linguistic2_XLinguServiceEventListener_idl__
  36 #include <com/sun/star/linguistic2/XLinguServiceEventListener.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com { module sun { module star { module linguistic2 {
  42
  43 //=============================================================================
  44 /** is used to register a listener for LinguServiceEvents.
  45
  46     <P>This interface may be used by spellchecker or hyphenator
  47     implementations to allow clients to be registered and informed about
  48     <type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s.
  49     </P>
  50
  51     <P>Note: The LinguServiceManager forwards the
  52     <type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s
  53     it receives (from spellcheckers or hyphenators) to its own listeners.
  54     Thus, there should be no need to register
  55     as a listener for a specific implementation./P>
  56
  57     @see    <type scope="com::sun::star::linguistic2">XLinguServiceManager</type>
  58     @see    <type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type>
  59 */
  60 published interface XLinguServiceEventBroadcaster : com::sun::star::uno::XInterface
  61 {
  62     //-------------------------------------------------------------------------
  63     /**
  64          @returns
  65              <TRUE/> if the listener was successfully added,
  66             <FALSE/> otherwise.
  67
  68         @param xLstnr
  69             the listener to be addded.
  70      */
  71     boolean addLinguServiceEventListener (
  72         [in] com::sun::star::linguistic2::XLinguServiceEventListener    xLstnr );
  73
  74     //-------------------------------------------------------------------------
  75     /**
  76          @returns
  77              <TRUE/> if the listener was successfully removed,
  78             <FALSE/> otherwise.
  79
  80         @param xLstnr
  81             the listener to be removed.
  82      */
  83     boolean removeLinguServiceEventListener (
  84         [in] com::sun::star::linguistic2::XLinguServiceEventListener    xLstnr );
  85
  86 };
  87
  88 //=============================================================================
  89
  90 }; }; }; };
  91
  92 #endif
  93